Phalcon adalah framework PHP full stack open source, ditulis sebagai ekstensi C, dioptimasi untuk performa tinggi. Anda tidak perlu belajar atau menggunakan bahasa C, karena fungsionalitasnya disediakan sebagai kelas PHP siap untuk Anda gunakan. Phalcon juga loose-coupled, memungkinkan Anda menggunakan objek-objeknya sebagai kom- ponen perekat sesuai kebutuhan aplikasi Anda. Phalcon tidak hanya tentang performa, tujuan kami adalah membuatnya kokoh, kaya fitur dan mudah digunakan!
PHP extensions require a slightly different installation method to a traditional PHP-based library or framework. You can either download a binary package for the system of your choice or build it from the sources.
Windows
To use phalcon on Windows you can download a DLL library. Edit your php.ini file and then append at the end: extension=php_phalcon.dll
Restart your webserver. The following screencast is a step-by-step guide to install Phalcon on Windows:
Related Guides
Installation on XAMPP
XAMPP is an easy to install Apache distribution containing MySQL, PHP and Perl. Once you download XAMPP, all you have to do is extract it and start using it. Below are detailed instructions on how to install Phalcon on XAMPP for Windows. Using the latest XAMPP version is highly recommended.
Download the right version of Phalcon
XAMPP is always releasing 32 bit versions of Apache and PHP. You will need to download the x86 version of Phalcon for Windows from the download section.
After downloading the Phalcon library you will have a zip file like the one shown below:
Extract the library from the archive to get the Phalcon DLL:
Copy the file php_phalcon.dll to the PHP extensions. If you have installed XAMPP in the C:\xampp folder, the extension needs to be in C:\xampp\php\ext Edit the php.ini file, it is located at C:\xampp\php\php.ini. It can be edited with Notepad or a similar program. We recommend Notepad++ to avoid issues with line endings. Append at the end of the file: extension=php_phalcon.dll and save it. Restart the Apache Web Server from the XAMPP Control Center. This will load the new PHP configuration. Open your browser to navigate to http://localhost. The XAMPP welcome page will appear. Click on the link phpinfo(). phpinfo() will output a significant amount of information on screen about the current state of PHP. Scroll down to check if the phalcon extension has been loaded correctly. If you can see the phalcon version in the phpinfo() output, congrats!, You are now flying with Phalcon.
Screencast
The following screencast is a step by step guide to install Phalcon on Windows:
Related Guides
• General Installation • Detailed Installation on WAMP for Windows
WampServer is a Windows web development environment. It allows you to create web applications with Apache2, PHP and a MySQL database. Below are detailed instructions on how to install Phalcon on WampServer for Windows. Using the latest WampServer version is highly recommended.
Download the right version of Phalcon
WAMP has both 32 and 64 bit versions. From the download section, you can choose the Phalcon for Windows accordingly to your desired architecture. After download the Phalcon library you will have a zip file like the one shown below:
Extract the library from the archive to get the Phalcon DLL:
Copy the file php_phalcon.dll to the PHP extensions. If WAMP is installed in the C:\wamp folder, the extension needs to be in C:\wamp\bin\php\php5.5.12\ext Edit the php.ini file, it is located at C:\wamp\bin\php\php5.5.12\php.ini. It can be edited with Notepad or a simi- lar program. We recommend Notepad++ to avoid issues with line endings. Append at the end of the file: exten- sion=php_phalcon.dll and save it. Also edit another php.ini file, which is located at C:\wamp\bin\apache\apache2.4.9\bin\php.ini. Append at the end of the file: extension=php_phalcon.dll and save it. Restart the Apache Web Server. Do a single click on the WampServer icon at system tray. Choose “Restart All Services” from the pop-up menu. Check out that tray icon will become green again. Open your browser to navigate to http://localhost. The WAMP welcome page will appear. Look at the section “exten- sions loaded” to check if phalcon was loaded. Congrats!, You are now flying with Phalcon.
This only needs to be done only once, unless your distribution changes or you want to switch from stable to nightly builds. To install Phalcon: sudo yum install php56u-phalcon
# or for PHP 7 sudo yum install php70u-phalcon
Compile from source
On a Linux/Solaris system you can easily compile and install the extension from the source code: Prerequisite packages are: • PHP >= 5.5 development resources • GCC compiler (Linux/Solaris) • Git (if not already installed in your system - unless you download the package from GitHub and upload it on your server via FTP/SFTP) Specific packages for common platforms:
# Ubuntu sudo apt-get install php5-dev libpcre3-dev gcc make php5-mysql
# MacPorts sudo port install php55-phalcon sudo port install php56-phalcon
Add extension to your PHP configuration.
FreeBSD
A port is available for FreeBSD. Just only need these simple line commands to install it: pkg_add -r phalcon or export CFLAGS="-O2 --fvisibility=hidden" cd /usr/ports/www/phalcon make install clean
Checking your installation
Check your phpinfo() output for a section referencing “Phalcon” or execute the code snippet below:
The Phalcon extension should appear as part of the output:
Apache adalah web server popular dan terkenal yang tersedia di beragam platform.
Konfigurasi Apache untuk Phalcon
Berikut ini adalah konfigurasi yang bisa anda gunakan untuk setup Apache dengan Phalcon. Catatan ini utamanya fokus pada konfigurasi modul mod_rewrite yang memungkinkan penggunaan URL yang ramah dan router component. Aplikasi biasanya menggunakan struktur berikut:
Ini adalah kasus paling umum, aplikasi diinstall pada sembarang direktori dalam document root. Pada kasus ini, kita menggunakan dua file .htaccess, yang pertama untuk menyembunyikan kode aplikasi dengan mengarahkan semua request ke document root aplikasi (public/).
# test/.htaccess
RewriteEngine on RewriteRule ^$ public/ [L] RewriteRule ((?s).*) public/$1 [L]
File .htaccess kedua diletakkan di direktori public/ , file ini menulis ulang semua URI ke file public/index.php:
Nginx is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. Unlike traditional servers, Nginx doesn’t rely on threads to handle requests. Instead it uses a much more
18 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 scalable event-driven (asynchronous) architecture. This architecture uses small, but more importantly, predictable amounts of memory under load. The PHP-FPM (FastCGI Process Manager) is usually used to allow Nginx to process PHP files. Nowadays, PHP-FPM is bundled with any Unix PHP distribution. Phalcon + Nginx+ PHP-FPM provides a powerful set of tools that offer maximum performance for your PHP applications.
Configuring Nginx for Phalcon
The following are potential configurations you can use to setup nginx with Phalcon:
Basic configuration
Using $_GET['_url'] as source of URIs: server { listen 80; server_name localhost.dev; root /var/www/phalcon/public; index index.php index.html index.htm; charset utf-8;
Using $_SERVER['REQUEST_URI'] as source of URIs: server { listen 80; server_name localhost.dev; root /var/www/phalcon/public; index index.php index.html index.htm; charset utf-8;
Cherokee adalah web server berkinerja tinggi. Ia sangat cepat, fleksibel dan mudah dikonfigurasi.
Mengkonfigurasi Cherokee untuk Phalcon
Cherokee menyediakan antarmuka grafis bersahabat untuk mengkonfigurasi hampir semua pengaturan yang tersedia di web server ini. Mulai sebagai administrator cherokee dengan menjalankan sebagai root /path-to- cherokee/sbin/cherokee-admin Menitpakan virtual host baru dengan mengklik pada ‘vServers’, lalu menambahkan virtual server baru: Virtual server yang baru ditambahkan muncul di sisi kiri layar. Di tab ‘Behaviors’ anda akan melihat default behaviors untuk virtual server ini. Klik tombol ‘Rule Management’. Hapus yang ditandai sebagai ‘Directory /cherokee_themes’ dan ‘Directory /icons’: Tambahkan ‘PHP Language’ behavior menggunakan wizard. Behavior ini memungkinkan anda menjalankan aplikasi PHP: Normalnya behavior ini tidak membutuhkan pengaturan tambahan. Tambahkan behavior lain, kali ini dibagian ‘Man- ual Configuration’. Di ‘Rule Type’ pilih ‘File Exists’, lalu pastikan pilihan ‘Match any file’ dihidupkan: Di tab ‘Handler’ pilih ‘List & Send’ sebagai handler: Edit behavior default ‘Default’ untuk menghidupkan URL-rewrite engine. Ubah handler ke ‘Redirection’, lalu tam- bahkan regular expression berikut ke engine ^(.*)$: Akhirnya, pastikan behavior memiliki urutan berikut: Eksekusi aplikasi di browser:
Menggunakan Web Server bawaan PHP
Mulai PHP 5.4.0, anda dapt menggunakan web server bawaan PHP untuk pengembangan. Untuk memulai server ketik: php -S localhost:8000 -t /public
Jika anda ingin menulis ulang URI ke file index.php gunakan file router berikut (.htrouter.php):
Lau arahkan browser anda ke http://localhost:8000/ untuk menguji apakah semuanya bekerja.
Phalcon Developer Tools
These tools are a collection of useful scripts to generate skeleton code. Core components of your application can be generated with a simple command, allowing you to easily develop applications using Phalcon. If you prefer to use the web version instead of the console, this blog post offers more information.
Download
You can download or clone a cross platform package containing the developer tools from Github.
These are detailed instructions on how to install the developer tools on different platforms:
Phalcon Developer Tools on Windows
These steps will guide you through the process of installing Phalcon Developer Tools for Windows.
Prerequisites
The Phalcon PHP extension is required to run Phalcon Tools. If you haven’t installed it yet, please see the Installation section for instructions.
Download
You can download a cross platform package containing the developer tools from the Download section. Also you can clone it from Github. On the Windows platform, you need to configure the system PATH to include Phalcon tools as well as the PHP executable. If you download the Phalcon tools as a zip archive, extract it on any path of your local drive i.e. c:\phalcon- tools. You will need this path in the steps below. Edit the file “phalcon.bat” by right clicking on the file and selecting “Edit”: Change the path to the one you installed the Phalcon tools (set PTOOLSPATH=C:phalcon-tools): Save the changes.
Adding PHP and Tools to your system PATH
Because the scripts are written in PHP, you need to install it on your machine. Depending on your PHP installation, the executable can be located in various places. Search for the file php.exe and copy the path it is located in. For instance, if using the latest WAMP stack, PHP is located in: C:\wampbin\php\php5.3.10\php.exe. From the Windows start menu, right mouse click on the “Computer” icon and select “Properties”: Click the “Advanced” tab and then the button “Environment Variables”: At the bottom, look for the section “System variables” and edit the variable “Path”: Be very careful on this step! You need to append at the end of the long string the path where your php.exe was located and the path where Phalcon tools are installed. Use the ”;” character to separate the different paths in the variable: Accept the changes made by clicking “OK” and close the dialogs opened. From the start menu click on the option “Run”. If you can’t find this option, press “Windows Key” + “R”. Type “cmd” and press enter to open the windows command line utility: Type the commands “php -v” and “phalcon” and you will see something like this: Congratulations you now have Phalcon tools installed!
• Using Developer Tools • Installation on OS X • Installation on Linux
Phalcon Developer Tools on Mac OS X
These steps will guide you through the process of installing Phalcon Developer Tools for OS/X.
Prerequisites
The Phalcon PHP extension is required to run Phalcon Tools. If you haven’t installed it yet, please see the Installation section for instructions.
Download
You can download a cross platform package containing the developer tools from the Download section. You can also clone it from Github. Open the terminal application:
Copy & Paste the commands below in your terminal: git clone git://github.com/phalcon/phalcon-devtools.git
Then enter the folder where the tools were cloned and execute ”. ./phalcon.sh”, (don’t forget the dot at beginning of the command):
In the terminal window, type the following commands to create a symbolic link to the phalcon.php script: ln -s ~/phalcon-tools/phalcon.php ~/phalcon-tools/phalcon chmod +x ~/phalcon-tools/phalcon
Type the command “phalcon” and you will see something like this:
Congratulations you now have Phalcon tools installed!
Related Guides
• Using Developer Tools • Installation on Windows • Installation on Linux
Phalcon Developer Tools di Linux
Langkah berikut akan memandu anda melalui proses menginstal Phalcon Developer Tools untuk Linux.
Ekstensi PHP Phalcon diperlukan untuk menjalankan Phalcon Tools. Jika belum menginstall, silakan lihat Installation untuk instruksi.
Download
Anda dapat mendownload cross platform package berisi developer tools dari bagian Download. Anda dapat juga clone dari Github. Buka terminal dan ketik perintah berikut: git clone git://github.com/phalcon/phalcon-devtools.git
Lalu masuk ke folder di mana tools diclone dan jalankan ”. ./phalcon.sh”, (Jangan lupa titik di awal perintah): cd phalcon-devtools/
. ./phalcon.sh
Buat symbolink ke script phalcon.php: ln -s ~/phalcon-devtools/phalcon.php /usr/bin/phalcon chmod ugo+x /usr/bin/phalcon
You can use Phalcon tools to generate pre-defined project skeletons for your applications with Phalcon framework. By default the project skeleton generator will use mod_rewrite for Apache. Type the following command on your web server document root:
$ pwd
/Applications/MAMP/htdocs
$ phalcon create-project store
The above recommended project structure was generated: You could add the parameter –help to get help on the usage of a certain script:
Options: --name Name of the new project --enable-webtools Determines if webtools should be enabled[optional] --directory=s Base path on which project will be created[optional] --type=s Type of the application to be generated(cli, micro, simple,
˓→modules) --template-path=s Specify a template path[optional] --use-config-ini Use a ini file as configuration file[optional] --trace Shows the trace of the framework in case of exception.
˓→[optional] --help Shows this help
Accessing the project from the web server will show you:
Generating Controllers
The command “create-controller” generates controller skeleton structures. It’s important to invoke this command inside a directory that already has a Phalcon project.
class TestController extends Controller { public function indexAction() {
} }
Preparing Database Settings
When a project is generated using developer tools. A configuration file can be found in app/config/config.ini To generate models or scaffold, you will need to change the settings used to connect to your database. Change the database section in your config.ini file:
There are several ways to create models. You can create all models from the default database connection or some selectively. Models can have public attributes for the field representations or setters/getters can be used. Options: --name=s Table name --schema=s Name of the schema. [optional] --namespace=s Model’s namespace [optional] --get-set Attributes will be protected and have setters/getters. [optional] --extends=s Model extends the class name supplied [optional] --excludefields=l Excludes fields defined in a comma separated list [optional] --doc Helps to improve code completion on IDEs [optional] --directory=s Base path on which project will be created [optional] --force Rewrite the model. [optional] --trace Shows the trace of the framework in case of exception. [optional] --mapcolumn Get some code for map columns. [optional] --abstract Abstract Model [optional] The simplest way to generate a model is:
$ phalcon model products
$ phalcon model --name tablename
All table fields are declared public for direct access.
By adding the –get-set you can generate the fields with protected variables and public setter/getter methods. Those methods can help in business logic implementation within the setter/getter methods.
/** * Method to set the value of field id * * @param integer $id */ public function setId($id) { $this->id= $id; }
/** * Method to set the value of field typesId * * @param integer $typesId */ public function setTypesId($typesId) { $this->typesId= $typesId; }
// ...
/** * Returns the value of field status * * @return string */ public function getStatus() { return $this->status; } }
A nice feature of the model generator is that it keeps changes made by the developer between code generations. This allows the addition or removal of fields and properties, without worrying about losing changes made to the model itself. The following screencast shows you how it works:
Scaffold a CRUD
Scaffolding is a quick way to generate some of the major pieces of an application. If you want to create the models, views, and controllers for a new resource in a single operation, scaffolding is the tool for the job. Once the code is generated, it will have to be customized to meet your needs. Many developers avoid scaffolding entirely, opting to write all or most of their source code from scratch. The generated code can serve as a guide to better understand of how the framework works or develop prototypes. The code below shows a scaffold based on the table “products”:
$ phalcon scaffold --table-name products
The scaffold generator will build several files in your application, along with some folders. Here’s a quick overview of what will be generated:
File Purpose app/controllers/ProductsController.php The Products controller app/models/Products.php The Products model app/views/layout/products.phtml Controller layout for Products app/views/products/new.phtml View for the action “new” app/views/products/edit.phtml View for the action “edit” app/views/products/search.phtml View for the action “search” When browsing the recently generated controller, you will see a search form and a link to create a new Product:
The “create page” allows you to create products applying validations on the Products model. Phalcon will automati- cally validate not null fields producing warnings if any of them is required. After performing a search, a pager component is available to show paged results. Use the “Edit” or “Delete” links in front of each result to perform such actions.
Web Interface to Tools
Also, if you prefer, it’s possible to use Phalcon Developer Tools from a web interface. Check out the following screencast to figure out how it works:
The screencast below shows how to integrate developer tools with the PhpStorm IDE. The configuration steps could be easily adapted to other IDEs for PHP.
Conclusion
Phalcon Developer Tools provides an easy way to generate code for your application, reducing development time and potential coding errors.
Tutorials
Tutorial 1: Let’s learn by example
Throughout this first tutorial, we’ll walk you through the creation of an application with a simple registration form from the ground up. We will also explain the basic aspects of the framework’s behavior. If you are interested in automatic code generation tools for Phalcon, you can check our developer tools. The best way to use this guide is to follow each step in turn. You can get the complete code here.
File structure
Phalcon does not impose a particular file structure for application development. Due to the fact that it is loosely coupled, you can implement Phalcon powered applications with a file structure you are most comfortable using. For the purposes of this tutorial and as a starting point, we suggest this very simple structure:
Note that you don’t need any “library” directory related to Phalcon. The framework is available in memory, ready for you to use. Before continuing, please be sure you’ve successfully installed Phalcon and have setup either Nginx, Apache or Chero- kee.
Bootstrap
The first file you need to create is the bootstrap file. This file is very important; since it serves as the base of your application, giving you control of all aspects of it. In this file you can implement initialization of components as well as application behavior. Ultimately, it is responsible for doing 3 things: 1. Setting up the autoloader. 2. Configuring the Dependency Injector.
The first part that we find in the bootstrap is registering an autoloader. This will be used to load classes as controllers and models in the application. For example we may register one or more directories of controllers increasing the flexibility of the application. In our example we have used the component Phalcon\Loader. With it, we can load classes using various strategies but for this example we have chosen to locate classes based on predefined directories:
A very important concept that must be understood when working with Phalcon is its dependency injection container. It may sound complex but is actually very simple and practical. A service container is a bag where we globally store the services that our application will use to function. Each time the framework requires a component, it will ask the container using an agreed upon name for the service. Since Phalcon is a highly decoupled framework, Phalcon\Di acts as glue facilitating the integration of the different components achieving their work together in a transparent manner.
use Phalcon\Di\FactoryDefault;
// ...
// Create a DI $di= new FactoryDefault();
Phalcon\Di\FactoryDefault is a variant of Phalcon\Di. To make things easier, it has registered most of the components that come with Phalcon. Thus we should not register them one by one. Later there will be no problem in replacing a factory service. In the next part, we register the “view” service indicating the directory where the framework will find the views files. As the views do not correspond to classes, they cannot be charged with an autoloader. Services can be registered in several ways, but for our tutorial we’ll use an anonymous function:
// Setup the view component $di->set( "view", function () { $view= new View();
$view->setViewsDir("../app/views/");
return $view; } );
Next we register a base URI so that all URIs generated by Phalcon include the “tutorial” folder we setup earlier. This will become important later on in this tutorial when we use the class Phalcon\Tag to generate a hyperlink.
// ...
// Setup a base URI so that all generated URIs include the "tutorial" folder $di->set( "url", function () { $url= new UrlProvider();
$url->setBaseUri("/tutorial/");
return $url; } );
Handling the application request
In the last part of this file, we find Phalcon\Mvc\Application. Its purpose is to initialize the request environment, route the incoming request, and then dispatch any discovered actions; it aggregates any responses and returns them when the process is complete.
As you can see, the bootstrap file is very short and we do not need to include any additional files. We have set ourselves a flexible MVC application in less than 30 lines of code.
Creating a Controller
By default Phalcon will look for a controller named “Index”. It is the starting point when no controller or action has been passed in the request. The index controller (app/controllers/IndexController.php) looks like:
Hello!"; } }
The controller classes must have the suffix “Controller” and controller actions must have the suffix “Action”. If you access the application from your browser, you should see something like this: Congratulations, you’re flying with Phalcon!
Sending output to a view
Sending output to the screen from the controller is at times necessary but not desirable as most purists in the MVC community will attest. Everything must be passed to the view that is responsible for outputting data on screen. Phalcon will look for a view with the same name as the last executed action inside a directory named as the last executed controller. In our case (app/views/index/index.phtml):
Hello!";
Our controller (app/controllers/IndexController.php) now has an empty action definition:
The browser output should remain the same. The Phalcon\Mvc\View static component is automatically created when the action execution has ended. Learn more about views usage here.
Designing a sign up form
Now we will change the index.phtml view file, to add a link to a new controller named “signup”. The goal is to allow users to sign up within our application.
To generate the tag we use the class Phalcon\Tag. This is a utility class that allows us to build HTML tags with framework conventions in mind. As this class is a also a service registered in the DI we use $this->tag to access it. A more detailed article regarding HTML generation can be found here.
Here is the Signup controller (app/controllers/SignupController.php):
use Phalcon\Mvc\Controller;
class SignupController extends Controller { public function indexAction() {
} }
The empty index action gives the clean pass to a view with the form definition (app/views/signup/index.phtml):
The Phalcon\Tag::form() method receives only one parameter for instance, a relative URI to a controller/action in the application. By clicking the “Send” button, you will notice an exception thrown from the framework, indicating that we are missing the “register” action in the controller “signup”. Our public/index.php file throws this exception: Exception: Action “register” was not found on handler “signup” Implementing that method will remove the exception:
}
public function registerAction() {
} }
If you click the “Send” button again, you will see a blank page. The name and email input provided by the user should be stored in a database. According to MVC guidelines, database interactions must be done through models so as to ensure clean object-oriented code.
Creating a Model
Phalcon brings the first ORM for PHP entirely written in C-language. Instead of increasing the complexity of devel- opment, it simplifies it. Before creating our first model, we need to create a database table outside of Phalcon to map it to. A simple table to store registered users can be defined like this:
CREATE TABLE `users`( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(70) NOT NULL, `email` varchar(70) NOT NULL,
PRIMARY KEY (`id`) );
A model should be located in the app/models directory (app/models/Users.php). The model maps to the “users” table:
In order to be able to use a database connection and subsequently access data through our models, we need to specify it in our bootstrap process. A database connection is just another service that our application has that can be used for several components:
// Setup the database service $di->set( "db", function () { return new DbAdapter( [ "host" =>"localhost", "username" =>"root", "password" =>"secret", "dbname" =>"test_db", ] ); } );
With the correct database parameters, our models are ready to work and interact with the rest of the application.
Storing data using models
Receiving data from the form and storing them in the table is the next step.
}
public function registerAction() { $user= new Users();
// Store and check for errors $success= $user->save( $this->request->getPost(), [ "name",
if ($success){ echo "Thanks for registering!"; } else { echo "Sorry, the following problems were generated:";
$messages= $user->getMessages();
foreach ($messages as $message){ echo $message->getMessage()," "; } }
$this->view->disable(); } }
We then instantiate the Users class, which corresponds to a User record. The class public properties map to the fields of the record in the users table. Setting the relevant values in the new record and calling save() will store the data in the database for that record. The save() method returns a boolean value which indicates whether the storing of the data was successful or not. The ORM automatically escapes the input preventing SQL injections so we only need to pass the request to the save() method. Additional validation happens automatically on fields that are defined as not null (required). If we don’t enter any of the required fields in the sign up form our screen will look like this:
This is a very simple tutorial and as you can see, it’s easy to start building an application using Phalcon. The fact that Phalcon is an extension on your web server has not interfered with the ease of development or features available. We invite you to continue reading the manual so that you can discover additional features offered by Phalcon!
Tutorial 2: Introducing INVO
In this second tutorial, we’ll explain a more complete application in order to gain a deeper understanding of developing with Phalcon. INVO is one of the sample applications we have created. INVO is a small website that allows users to generate invoices and do other tasks such as manage customers and products. You can clone its code from Github. INVO was made with the client-side framework Bootstrap. Although the application does not generate actual invoices, it still serves as an example showing how the framework works.
Project Structure
Once you clone the project in your document root you’ll see the following structure: invo/ app/ config/ controllers/ forms/ library/ logs/ models/ plugins/ views/ cache/ volt/ docs/ public/ css/ fonts/ js/ schemas/
As you know, Phalcon does not impose a particular file structure for application development. This project has a simple MVC structure and a public document root. Once you open the application in your browser http://localhost/invo you’ll see something like this: The application is divided into two parts: a frontend and a backend. The frontend is a public area where visitors can receive information about INVO and request contact information. The backend is an administrative area where registered users can manage their products and customers.
Routing
INVO uses the standard route that is built-in with the Router component. These routes match the following pattern: /:controller/:action/:params. This means that the first part of a URI is the controller, the second the controller action and the rest are the parameters. The following route /session/register executes the controller SessionController and its action registerAction.
INVO has a configuration file that sets general parameters in the application. This file is located at app/config/config.ini and is loaded in the very first lines of the application bootstrap (public/index.php):
// ...
// Read the configuration $config= new ConfigIni( APP_PATH."app/config/config.ini" );
Phalcon\Config allows us to manipulate the file in an object-oriented way. In this example, we’re using an ini file for configuration but Phalcon has adapters for other file types as well. The configuration file contains the following settings:
Phalcon doesn’t have any pre-defined settings convention. Sections help us to organize the options as appropriate. In this file there are two sections to be used later: “application” and “database”.
Autoloaders
The second part that appears in the bootstrap file (public/index.php) is the autoloader:
The autoloader registers a set of directories in which the application will look for the classes that it will eventually need.
$loader= new Phalcon\Loader();
// We're a registering a set of directories taken from the configuration file $loader->registerDirs( [ APP_PATH. $config->application->controllersDir, APP_PATH. $config->application->pluginsDir, APP_PATH. $config->application->libraryDir, APP_PATH. $config->application->modelsDir, APP_PATH. $config->application->formsDir, ] );
$loader->register();
Note that the above code has registered the directories that were defined in the configuration file. The only directory that is not registered is the viewsDir because it contains HTML + PHP files but no classes. Also, note that we use a constant called APP_PATH. This constant is defined in the bootstrap (public/index.php) to allow us to have a reference to the root of our project:
Service registration is achieved as in the previous tutorial, making use of closures to lazily load the required compo- nents:
use Phalcon\Mvc\Url as UrlProvider;
// ...
/** * The URL component is used to generate all kind of URLs in the application */ $di->set( "url", function () use ($config){ $url= new UrlProvider();
If we skip to the end of the file (public/index.php), the request is finally handled by Phalcon\Mvc\Application which initializes and executes all that is necessary to make the application run:
In the first line of the code block above, the Application class constructor is receiving the variable $di as an argument. What is the purpose of that variable? Phalcon is a highly decoupled framework so we need a component that acts as glue to make everything work together. That component is Phalcon\Di. It’s a service container that also performs dependency injection and service location, instantiating all components as they are needed by the application. There are many ways of registering services in the container. In INVO, most services have been registered using anonymous functions/closures. Thanks to this, the objects are instantiated in a lazy way, reducing the resources needed by the application. For instance, in the following excerpt the session service is registered. The anonymous function will only be called when the application requires access to the session data:
// ...
// Start the session the first time a component requests the session service $di->set( "session", function () { $session= new Session();
$session->start();
return $session; } );
Here, we have the freedom to change the adapter, perform additional initialization and much more. Note that the service was registered using the name “session”. This is a convention that will allow the framework to identify the active service in the services container. A request can use many services and registering each service individually can be a cumbersome task. For that reason, the framework provides a variant of Phalcon\Di called Phalcon\Di\FactoryDefault whose task is to register all services providing a full-stack framework.
// ...
// The FactoryDefault Dependency Injector automatically registers the // right services providing a full-stack framework $di= new FactoryDefault();
It registers the majority of services with components provided by the framework as standard. If we need to override the definition of some service we could just set it again as we did above with “session” or “url”. This is the reason for the existence of the variable $di. In next chapter, we will see how authentication and authorization is implemented in INVO.
In this chapter, we continue explaining how INVO is structured, we’ll talk about the implementation of authentication, authorization using events and plugins and an access control list (ACL) managed by Phalcon.
Log into the Application
A “log in” facility will allow us to work on backend controllers. The separation between backend controllers and frontend ones is only logical. All controllers are located in the same directory (app/controllers/). To enter the system, users must have a valid username and password. Users are stored in the table “users” in the database “invo”. Before we can start a session, we need to configure the connection to the database in the application. A service called “db” is set up in the service container with the connection information. As with the autoloader, we are again taking parameters from the configuration file in order to configure a service:
// ...
// Database connection is created based on parameters defined in the configuration
˓→file $di->set( "db", function () use ($config){ return new DbAdapter( [ "host" => $config->database->host, "username" => $config->database->username, "password" => $config->database->password, "dbname" => $config->database->name, ] ); } );
Here, we return an instance of the MySQL connection adapter. If needed, you could do extra actions such as adding a logger, a profiler or change the adapter, setting it up as you want. The following simple form (app/views/session/index.volt) requests the login information. We’ve removed some HTML code to make the example more concise:
{{ form("session/start") }}
{{ endForm() }}
Instead of using raw PHP as the previous tutorial, we started to use Volt. This is a built-in template engine inspired in Jinja providing a simpler and friendly syntax to create templates. It will not take too long before you become familiar with Volt. The SessionController::startAction function (app/controllers/SessionController.php) has the task of val- idating the data entered in the form including checking for a valid user in the database:
/** * This action authenticate and logs a user into the application */ public function startAction() { if ($this->request->isPost()) { // Get the data from the user $email= $this->request->getPost("email"); $password= $this->request->getPost("password");
// Find the user in the database $user= Users::findFirst( [ "(email = :email: OR username = :email:) AND password =
˓→:password: AND active = 'Y'", "bind" =>[ "email" => $email,
if ($user !== false){ $this->_registerSession($user);
$this->flash->success( "Welcome". $user->name );
// Forward to the 'invoices' controller if the user is valid return $this->dispatcher->forward( [ "controller" =>"invoices", "action" =>"index", ] ); }
$this->flash->error( "Wrong email/password" ); }
// Forward to the login form again return $this->dispatcher->forward( [ "controller" =>"session", "action" =>"index", ] ); } }
For the sake of simplicity, we have used “sha1” to store the password hashes in the database, however, this algorithm is not recommended in real applications, use “bcrypt” instead. Note that multiple public attributes are accessed in the controller like: $this->flash, $this->request or $this->session. These are services defined in the services container from earlier (app/config/services.php). When they’re accessed the first time, they are injected as part of the controller. These services are “shared”, which means that we are always accessing the same instance regardless of the place where we invoke them. For instance, here we invoke the “session” service and then we store the user identity in the variable “auth”:
Note, the use of ‘bound parameters’, placeholders :email: and :password: are placed where values should be, then the values are ‘bound’ using the parameter ‘bind’. This safely replaces the values for those columns without having the risk of a SQL injection. If the user is valid we register it in session and forwards him/her to the dashboard:
The backend is a private area where only registered users have access. Therefore, it is necessary to check that only registered users have access to these controllers. If you aren’t logged into the application and you try to access, for example, the products controller (which is private) you will see a screen like this:
Every time someone attempts to access any controller/action, the application verifies that the current role (in session) has access to it, otherwise it displays a message like the above and forwards the flow to the home page. Now let’s find out how the application accomplishes this. The first thing to know is that there is a component called Dispatcher. It is informed about the route found by the Routing component. Then, it is responsible for loading the appropriate controller and execute the corresponding action method. Normally, the framework creates the Dispatcher automatically. In our case, we want to perform a verification before executing the required action, checking if the user has access to it or not. To achieve this, we have replaced the component by creating a function in the bootstrap:
We now have total control over the Dispatcher used in the application. Many components in the framework trigger events that allow us to modify their internal flow of operation. As the Dependency Injector component acts as glue for components, a new component called EventsManager allows us to intercept the events produced by a component, routing the events to listeners.
Events Management
An EventsManager allows us to attach listeners to a particular type of event. The type that interests us now is “dis- patch”. The following code filters all events produced by the Dispatcher:
use Phalcon\Mvc\Dispatcher; use Phalcon\Events\Manager as EventsManager;
$di->set( "dispatcher", function () { // Create an events manager $eventsManager= new EventsManager();
// Listen for events produced in the dispatcher using the Security plugin $eventsManager->attach( "dispatch:beforeExecuteRoute", new SecurityPlugin() );
// Handle exceptions and not-found exceptions using NotFoundPlugin $eventsManager->attach( "dispatch:beforeException", new NotFoundPlugin() );
$dispatcher= new Dispatcher();
// Assign the events manager to the dispatcher $dispatcher->setEventsManager($eventsManager);
return $dispatcher; } );
When an event called “beforeExecuteRoute” is triggered the following plugin will be notified:
/** * Check if the user is allowed to access certain action using the SecurityPlugin */ $eventsManager->attach( "dispatch:beforeExecuteRoute", new SecurityPlugin() );
When a “beforeException” is triggered then other plugin is notified:
/** * Handle exceptions and not-found exceptions using NotFoundPlugin */ $eventsManager->attach( "dispatch:beforeException", new NotFoundPlugin() );
SecurityPlugin is a class located at (app/plugins/SecurityPlugin.php). This class implements the method “beforeExe- cuteRoute”. This is the same name as one of the events produced in the Dispatcher:
use Phalcon\Events\Event; use Phalcon\Mvc\User\Plugin; use Phalcon\Mvc\Dispatcher;
class SecurityPlugin extends Plugin { // ...
public function beforeExecuteRoute(Event $event, Dispatcher $dispatcher) { // ... } }
The hook events always receive a first parameter that contains contextual information of the event produced ($event) and a second one that is the object that produced the event itself ($dispatcher). It is not mandatory that plugins extend the class Phalcon\Mvc\User\Plugin, but by doing this they gain easier access to the services available in the application. Now, we’re verifying the role in the current session, checking if the user has access using the ACL list. If the user does not have access we redirect to the home screen as explained before:
use Phalcon\Acl; use Phalcon\Events\Event; use Phalcon\Mvc\User\Plugin; use Phalcon\Mvc\Dispatcher;
// Returning "false" we tell to the dispatcher to stop the current
˓→operation return false; } } }
Providing an ACL list
In the above example we have obtained the ACL using the method $this->getAcl(). This method is also imple- mented in the Plugin. Now we are going to explain step-by-step how we built the access control list (ACL):
// The default action is DENY access $acl->setDefaultAction( Acl::DENY );
// Register two roles, Users is registered users // and guests are users without a defined identity $roles=[ "users" => new Role("Users"), "guests" => new Role("Guests"), ]; foreach ($roles as $role){ $acl->addRole($role); }
Now, we define the resources for each area respectively. Controller names are resources and their actions are accesses for the resources:
// ...
// Private area resources (backend) $privateResources=[ "companies" =>["index","search","new","edit","save","create","delete"], "products" =>["index","search","new","edit","save","create","delete"], "producttypes" =>["index","search","new","edit","save","create","delete"], "invoices" =>["index","profile"], ]; foreach ($privateResources as $resourceName => $actions){ $acl->addResource( new Resource($resourceName), $actions ); }
// Public area resources (frontend) $publicResources=[ "index" =>["index"], "about" =>["index"], "register" =>["index"], "errors" =>["show404","show500"], "session" =>["index","register","start","end"], "contact" =>["index","send"], ]; foreach ($publicResources as $resourceName => $actions){ $acl->addResource( new Resource($resourceName), $actions
The ACL now have knowledge of the existing controllers and their related actions. Role “Users” has access to all the resources of both frontend and backend. The role “Guests” only has access to the public area:
// Grant access to public areas to both users and guests foreach ($roles as $role){ foreach ($publicResources as $resource => $actions){ $acl->allow( $role->getName(), $resource, "*" ); } }
// Grant access to private area only to role Users foreach ($privateResources as $resource => $actions){ foreach ($actions as $action){ $acl->allow( "Users", $resource, $action ); } }
Hooray!, the ACL is now complete. In next chapter, we will see how a CRUD is implemented in Phalcon and how you can customize it.
Tutorial 4: Working with the CRUD
Backends usually provide forms to allow users to manipulate data. Continuing the explanation of INVO, we now ad- dress the creation of CRUDs, a very common task that Phalcon will facilitate you using forms, validations, paginators and more. Most options that manipulate data in INVO (companies, products and types of products) were developed using a basic and common CRUD (Create, Read, Update and Delete). Each CRUD contains the following files: invo/ app/ controllers/ ProductsController.php models/ Products.php forms/ ProductsForm.php views/ products/ edit.volt index.volt new.volt search.volt
/** * Execute the "search" based on the criteria sent from the "index" * Returning a paginator for the results */ public function searchAction() { // ... }
/** * Shows the view to create a "new" product */ public function newAction() { // ... }
/** * Shows the view to "edit" an existing product */ public function editAction() { // ... }
/** * Creates a product based on the data entered in the "new" action */ public function createAction() { // ... }
/** * Updates a product based on the data entered in the "edit" action */ public function saveAction() { // ... }
/** * Deletes an existing product */ public function deleteAction($id)
Every CRUD starts with a search form. This form shows each field that the table has (products), allowing the user to create a search criteria for any field. The “products” table has a relationship with the table “products_types”. In this case, we previously queried the records in this table in order to facilitate the search by that field:
/** * The start action, it shows the "search" view */ public function indexAction() { $this->persistent->searchParams= null;
$this->view->form= new ProductsForm(); }
An instance of the ProductsForm form (app/forms/ProductsForm.php) is passed to the view. This form defines the fields that are visible to the user:
new PresenceOf( [ "message" =>"Price is required", ] ), new Numericality( [ "message" =>"Price is required", ] ), ] );
$this->add($price); } }
The form is declared using an object-oriented scheme based on the elements provided by the forms component. Every element follows almost the same structure:
// Create the element $name= new Text("name");
// Set its label $name->setLabel("Name");
// Before validating the element apply these filters $name->setFilters( [ "striptags", "string", ] );
// Apply this validators $name->addValidators( [ new PresenceOf( [ "message" =>"Name is required", ] ) ] );
// Add the element to the form $this->add($name);
Other elements are also used in this form:
// Add a hidden input to the form $this->add( new Hidden("id") );
// Add a HTML Select (list) to the form // and fill it with data from "product_types" $type= new Select( "profilesId", $productTypes, [ "using" =>[ "id", "name", ], "useEmpty" => true, "emptyText" =>"...", "emptyValue" =>"", ] );
Note that ProductTypes::find() contains the data necessary to fill the SELECT tag using Phalcon\Tag::select(). Once the form is passed to the view, it can be rendered and presented to the user:
{{ form("products/search") }}
Search products
{{ endForm() }}
This produces the following HTML:
When the form is submitted, the “search” action is executed in the controller performing the search based on the data entered by the user.
The “search” action has two behaviors. When accessed via POST, it performs a search based on the data sent from the form but when accessed via GET it moves the current page in the paginator. To differentiate HTTP methods, we check it using the Request component:
/** * Execute the "search" based on the criteria sent from the "index" * Returning a paginator for the results */ public function searchAction() { if ($this->request->isPost()) { // Create the query conditions } else { // Paginate using the existing conditions }
// ... }
With the help of Phalcon\Mvc\Model\Criteria, we can create the search conditions intelligently based on the data types and values sent from the form:
This method verifies which values are different from “” (empty string) and null and takes them into account to create the search criteria: • If the field data type is text or similar (char, varchar, text, etc.) It uses an SQL “like” operator to filter the results. • If the data type is not text or similar, it’ll use the operator “=”. Additionally, “Criteria” ignores all the $_POST variables that do not match any field in the table. Values are automat- ically escaped using “bound parameters”. Now, we store the produced parameters in the controller’s session bag:
A session bag, is a special attribute in a controller that persists between requests using the session service. When accessed, this attribute injects a Phalcon\Session\Bag instance that is independent in each controller. Then, based on the built params we perform the query:
$products= Products::find($parameters); if (count($products) ===0){
If the search doesn’t return any product, we forward the user to the index action again. Let’s pretend the search returned results, then we create a paginator to navigate easily through them:
// ...
$paginator= new Paginator( [ "data" => $products, // Data to paginate "limit" =>5, // Rows per page "page" => $numberPage, // Active page ] );
// Get active page in the paginator $page= $paginator->getPaginate();
Finally we pass the returned page to view:
$this->view->page= $page;
In the view (app/views/products/search.volt), we traverse the results corresponding to the current page, showing every row in the current page to the user:
{% for product in page.items %} {% if loop.first %}
{% endif %} {% else %} No products are recorded {% endfor %}
There are many things in the above example that worth detailing. First of all, active items in the current page are traversed using a Volt’s ‘for’. Volt provides a simpler syntax for a PHP ‘foreach’.
As we seen before using product.id is the same as in PHP as doing: $product->id, we made the same with product.name and so on. Other fields are rendered differently, for instance, let’s focus in product. productTypes.name. To understand this part, we have to check the Products model (app/models/Products.php):
/** * Products */ class Products extends Model { // ...
/** * Products initializer */ public function initialize() { $this->belongsTo( "product_types_id", "ProductTypes", "id", [ "reusable" => true, ] ); }
// ... }
A model can have a method called initialize(), this method is called once per request and it serves the ORM to initialize a model. In this case, “Products” is initialized by defining that this model has a one-to-many relationship to another model called “ProductTypes”.
Which means, the local attribute “product_types_id” in “Products” has an one-to-many relation to the “ProductTypes” model in its attribute “id”. By defining this relationship we can access the name of the product type by using:
{{ product.productTypes.name }}
The field “price” is printed by its formatted using a Volt filter:
{{ "%.2f"|format(product.price) }}
In plain PHP, this would be:
price) ?>
Printing whether the product is active or not uses a helper implemented in the model:
Now let’s see how the CRUD creates and updates records. From the “new” and “edit” views, the data entered by the user is sent to the “create” and “save” actions that perform actions of “creating” and “updating” products, respectively. In the creation case, we recover the data submitted and assign them to a new “Products” instance:
/** * Creates a product based on the data entered in the "new" action */ public function createAction() { if (!$this->request->isPost()) { return $this->dispatcher->forward( [ "controller" =>"products", "action" =>"index", ] ); }
Remember the filters we defined in the Products form? Data is filtered before being assigned to the object $product. This filtering is optional; the ORM also escapes the input data and performs additional casting according to the column types:
// ...
$name= new Text("name");
$name->setLabel("Name");
// Filters for name $name->setFilters( [ "striptags", "string",
// Validators for name $name->addValidators( [ new PresenceOf( [ "message" =>"Name is required", ] ) ] );
$this->add($name);
When saving, we’ll know whether the data conforms to the business rules and validations implemented in the form ProductsForm form (app/forms/ProductsForm.php):
// ...
$form= new ProductsForm();
$product= new Products();
// Validate the input $data= $this->request->getPost(); if (!$form->isValid($data, $product)) { $messages= $form->getMessages();
foreach ($messages as $message){ $this->flash->error($message); }
The data found is bound to the form by passing the model as first parameter. Thanks to this, the user can change any value and then sent it back to the database through to the “save” action:
/** * Updates a product based on the data entered in the "edit" action */ public function saveAction() { if (!$this->request->isPost()) { return $this->dispatcher->forward( [ "controller" =>"products", "action" =>"index", ] ); }
$id= $this->request->getPost("id","int");
$product= Products::findFirstById($id);
if (!$product){ $this->flash->error( "Product does not exist" );
We have seen how Phalcon lets you create forms and bind data from a database in a structured way. In next chapter, we will see how to add custom HTML elements like a menu.
Tutorial 5: Customizing INVO
To finish the detailed explanation of INVO we are going to explain how to customize INVO adding UI elements and changing the title according to the controller executed.
User Components
All the UI elements and visual style of the application has been achieved mostly through Bootstrap. Some elements, such as the navigation bar changes according to the state of the application. For example, in the upper right corner, the link “Log in / Sign Up” changes to “Log out” if a user is logged into the application. This part of the application is implemented in the component “Elements” (app/library/Elements.php).
use Phalcon\Mvc\User\Component;
class Elements extends Component { public function getMenu() { // ... }
This class extends the Phalcon\Mvc\User\Component. It is not imposed to extend a component with this class, but it helps to get access more quickly to the application services. Now, we are going to register our first user component in the services container:
// Register a user component $di->set( "elements", function () { return new Elements(); } );
As controllers, plugins or components within a view, this component also has access to the services registered in the container and by just accessing an attribute with the same name as a previously registered service:
When you browse between one option and another will see that the title changes dynamically indicating where we are currently working. This is achieved in each controller initializer:
public function initialize() { // Set the document title $this->tag->setTitle( "Manage your product types" );
parent::initialize(); }
// ... }
Note, that the method parent::initialize() is also called, it adds more data to the title:
use Phalcon\Mvc\Controller;
class ControllerBase extends Controller { protected function initialize() { // Prepend the application name to the title $this->tag->prependTitle( "INVO |" ); }
// ... }
Finally, the title is printed in the main view (app/views/index.volt):
tag->getTitle(); ?>
Tutorial 6: Vökuró
Vökuró is another sample application you can use to learn more about Phalcon. Vökuró is a small website that shows how to implement a security features and management of users and permissions. You can clone its code from Github.
Project Structure
Once you clone the project in your document root you’ll see the following structure:
This project follows a quite similar structure to INVO. Once you open the application in your browser http://localhost/ vokuro you’ll see something like this:
The application is divided into two parts, a frontend, where visitors can sign up the service and a backend where administrative users can manage registered users. Both frontend and backend are combined in a single module.
Load Classes and Dependencies
This project uses Phalcon\Loader to load controllers, models, forms, etc. within the project and composer to load the project’s dependencies. So, the first thing you have to do before execute Vökuró is install its dependencies via composer. Assuming you have it correctly installed, type the following command in the console: cd vokuro composer install
Vökuró sends emails to confirm the sign up of registered users using Swift, the composer.json looks like:
Now, there is a file called app/config/loader.php where all the auto-loading stuff is set up. At the end of this file you can see that the composer autoloader is included enabling the application to autoload any of the classes in the downloaded dependencies:
// ...
// Use composer autoloader to load vendor classes require_once BASE_PATH."/vendor/autoload.php";
Moreover, Vökuró, unlike the INVO, utilizes namespaces for controllers and models which is the recommended practice to structure a project. This way the autoloader looks slightly different than the one we saw before (app/config/loader.php):
Instead of using registerDirectories(), we use registerNamespaces(). Every namespace points to a directory defined in the configuration file (app/config/config.php). For instance the namespace Vokuro\Controllers points to app/controllers so all the classes required by the application within this namespace requires it in its definition:
namespace Vokuro\Controllers;
class AboutController extends ControllerBase { // ... }
First, let’s check how users are registered in Vökuró. When a user clicks the “Create an Account” button, the controller SessionController is invoked and the action “signup” is executed:
// ...
$this->view->form= $form; } }
This action simply pass a form instance of SignUpForm to the view, which itself is rendered to allow the user enter the login details:
In this tutorial, we will explain how to create a simple application that provides a RESTful API using the different HTTP methods: • GET to retrieve and search data • POST to add data • PUT to update data • DELETE to delete data
Defining the API
The API consists of the following methods: Method URL Action GET /api/robots Retrieves all robots GET /api/robots/search/Astro Searches for robots with ‘Astro’ in their name GET /api/robots/2 Retrieves robots based on primary key POST /api/robots Adds a new robot PUT /api/robots/2 Updates robots based on primary key DELETE /api/robots/2 Deletes robots based on primary key
Creating the Application
As the application is so simple, we will not implement any full MVC environment to develop it. In this case, we will use a micro application to meet our goal. The following file structure is more than enough:
// Deletes robots based on primary key $app->delete( "/api/robots/{id:[0-9]+}", function () {
} );
$app->handle();
Each route is defined with a method with the same name as the HTTP method, as first parameter we pass a route pattern, followed by a handler. In this case, the handler is an anonymous function. The following route: '/api/ robots/{id:[0-9]+}', by example, explicitly sets that the “id” parameter must have a numeric format. When a defined route matches the requested URI then the application executes the corresponding handler.
Creating a Model
Our API provides information about ‘robots’, these data are stored in a database. The following model allows us to access that table in an object-oriented way. We have implemented some business rules using built-in validators and simple validations. Doing this will give us the peace of mind that saved data meet the requirements of our application:
// Set up the database service $di->set( "db", function () { return new PdoMysql( [ "host" =>"localhost", "username" =>"asimov", "password" =>"zeroth", "dbname" =>"robotics", ] ); } );
// Create and bind the DI to the application $app= new Micro($di);
Retrieving Data
The first “handler” that we will implement is which by method GET returns all available robots. Let’s use PHQL to perform this simple query returning the results as JSON:
// Retrieves all robots $app->get( "/api/robots", function () use ($app){ $phql="SELECT * FROM Store\\Toys\\Robots ORDER BY name";
PHQL, allow us to write queries using a high-level, object-oriented SQL dialect that internally translates to the right SQL statements depending on the database system we are using. The clause “use” in the anonymous function allows us to pass some variables from the global to local scope easily. The searching by name handler would look like:
// Searches for robots with $name in their name $app->get( "/api/robots/search/{name}", function ($name) use ($app){ $phql="SELECT * FROM Store\\Toys\\Robots WHERE name LIKE :name: ORDER BY ˓→name";
Searching by the field “id” it’s quite similar, in this case, we’re also notifying if the robot was found or not:
// Retrieves robots based on primary key $app->get( "/api/robots/{id:[0-9]+}", function ($id) use ($app){ $phql="SELECT * FROM Store\\Toys\\Robots WHERE id = :id:";
// Check if the insertion was successful if ($status->success() === true){ $response->setJsonContent( [ "status" =>"OK" ] ); } else { // Change the HTTP status $response->setStatusCode(409,"Conflict");
$errors= [];
foreach ($status->getMessages() as $message){ $errors[]= $message->getMessage(); }
The data delete is similar to update. The “id” passed as parameter indicates what robot must be deleted:
// Deletes robots based on primary key $app->delete( "/api/robots/{id:[0-9]+}", function ($id) use ($app){ $phql="DELETE FROM Store \\Toys\\Robots WHERE id = :id:";
Using curl we’ll test every route in our application verifying its proper operation. Obtain all the robots: curl -i -X GET http://localhost/my-rest-api/api/robots
Try to insert a new robot with the name of an existing robot: curl -i -X POST -d '{"name":"C-3PO","type":"droid","year":1977}' http://localhost/my-rest-api/api/robots
As we have seen, develop a RESTful API with Phalcon is easy. Later in the documentation we’ll explain in detail how to use micro applications and the PHQL language.
List of examples
Following examples are full applications you can use to learn more about Phalcon and use them as base for your own websites/applications:
Before reading this section, it is wise to read the section which explains why Phalcon uses service location and dependency injection. Phalcon\Di adalah komponen yang mengimplementasi Dependency Injection dan Location of services dan merupakan kontainer service. Karena Phalcon memiliki ketergantungan minimal (highly decoupled), Phalcon\Di penting untuk mengintegrasikan beragam komponen framework. Developer dapat juga menggunakan komponen ini untuk menginjeksi ketergantungan dan mengelola instance global kelas-kelas berbeda yang digunakan aplikasi. Pada dasarnya, komponen ini mengimplementasi pola Inversion of Control . Dengan menerapkannya, objek-objek tidak menerima ketergantungannya menggunakan setter atau konstruktor, namun meminta service dependency injec- tor. Ini menurunkan kompleksitias keseluruhan karena hanya ada satu cara untuk mendapatkan ketergantungan yang dibutuhkan dalam sebuah komponen. Tambahan lagi, pola ini menaikkan testabilitas dalam kode, sehingga menjadikannya tidak rawan kesalahan.
Mendaftarkan service dalam Kontainer
Framework sendiri atau developer dapat mendaftarkan service. Ketika sebuah komponen A membutuhkan komponen B (atau instance kelas itu) untuk bekerja, ia dapat meminta komponen B dari kontainer, daripada menciptakan instance komponen B baru. Cara kerja ini memberi kita banyak keuntungan: • Kita dapat mudah mengganti sebuah komponen dengan milik kita sendiri atau pihak ketiga. • Kita memiliki kendali penuh atas inisialisasi objek, memungkinkan kita mengatur objek ini sebelum mem- berikan ke komponen. • Kita dapat instance global komponen dengan cara yang terstruktur dan menyatu. Service dapat didaftarkan dengan beberapa jenis definisi:
Regitrasi Sederhana
Seperti terlihat sebelumnya, ada beberapa cara untuk mendaftarkan service. Ini kita sebut sederhana:
String
Jenis mengharapkan nama kelas valid, mengembalikan sebuah objek dari kelas yang ditentukan, jika kelas tidak dimuat ia akan diciptakan menggunakan auto-loader. Jenis definisi ini tidak mengizinkan untuk menentukan argumen untuk kontruktor kelas atau parameter:
// mengembalikan new Phalcon\Http\Request(); $di->set( "request", "Phalcon\\Http\\Request" );
Jenis ini mengharapkan sebuah objek. Karena fakta bahwa objek tidak perlu di resolve karena ia sudah objek, bisa dibilang ini tidak benar-benar dependency injection, namun ia berguna jika anda ingin memaksa ketergantungan yang diberikan selalu objek atau nilai yang sama:
// mengembalikan new Phalcon\Http\Request(); $di->set( "request", new Request() );
Closure/Fungsi Anonymous
Metode ini menawarkan kebebasan lebih besar dengan membangun ketergantungan sesuai keinginan, namun, ia sulit mengubah beberapa parameter secara ekternal tanpa mengubah definisi ketergantungan:
Jika diperlukan untuk mengubah definisi service tanpa perlu menciptakan/resolve service, maka, kita butuh menen- tukan service menggunakan sintaks array. Menentukan service menggunakan definisi array dapat terlihat lebih ramai:
Service “response” (Phalcon\Http\Response) di resolve lalu dilewatkan ke argumen pertama konstruktor, sedangkan yang kedua adalah nilai boolean (true) yang dilewatkan apa adanya.
Injeksi Setter
Kelas mungkin punya setter untuk menyisipkan ketergantungan tidak wajib, kelas kita sebelumnya dapat diubah untuk menerima ketergantungan dengan setter:
Jenis parameter yang didukung termasuk berikut ini: Jenis Keterangan Contoh pa- Mewakili nilai asli yang ["type" => "parameter", "value" => 1234] rame- dilewatkan sebagai parameter ter ser- Mewakili service lain dalam ["type" => "service", "name" => "request"] vice kontainer service in- Mewakili objek yang harus ["type" => "instance", "className" => stance diciptakan dinamis "DateTime", "arguments" => ["now"]] Resolve service yang definisinya kompleks mungkin lebih lambat dibandingkan yang sederhana seperti yang sudah terlihat sebelumnya. Namun, ia menyediakan pendekatan yang lebih kokoh untuk mendefinisi dan menginjeksi ser- vice. Mencampur jenis definisi berbeda diizinkan, semua orang dapat memutuskan cara apa yang paling cocok mendaftarkan service tergantung kebutuhan aplikasi.
Array Syntax
Sintaks array juga diizinkan untuk mendaftarkan service:
use Phalcon\Di; use Phalcon\Http\Request;
// Buat Dependency Injector Container $di= new Di();
// Menggunakan nama kelas $di["request"]="Phalcon \\Http\\Request";
// Menggunakan fungsi anonymous function, instance akan dimuat secara lazy load $di["request"]= function () { return new Request(); };
// Mendaftarkan instance langsung $di["request"]= new Request();
// Menggunakan definisi array $di["request"]=[ "className" =>"Phalcon \\Http\\Request", ];
Dicontoh diatas, ketika framework butuh mengakses data request, ia akan meminta service yang diidentifikasi sebagai ‘request’ dalam kontainer. Kontainer kemudian mengembalikan instance service yang diminta. Developer mungkin suatu saat mengganti sebuah komponen ketika mereka butuh. Tiap metode (ditunjukkan di contoh diatas) yang digunakan untuk mengatur/mendaftarkan service punya kelebihan dan kekurangan. Tergantung developer dan kebutuhan tertentu yang mengarahkan mana yang digunakan.
Mengatur service dengan string mudah, namun kurang fleksibilitas. Mengatur service dengan array menawarkan lebih banyak fleksibilitas, namun menjadikan kode lebih rumit. Fungsi lambda adalah keseimbangan bagus diantara keduanya, namun dapat menyebabkan lebih banyak maintenance dari yang diharapkan. Phalcon\Di menawarkan lazy loading untuk semua service yang disimpan. Kecuali developer memilih menciptakan objek langsung dan menyimpannya dalam kontainer, tiap objek yang disimpan didalamnya (melalui array, string dan lain-lain) akan di muat secara lazy load yakni hanya akan diciptakan ketika diminta.
Resolving Services
Mendapatkan service dari kontainer hanya masalah memanggil metode “get”. Instance baru service akan dikemba- likan:
get("request");
Atau menggunakan metode magic:
$request= $di->getRequest();
Atau menggunakan sintaks akses array:
$request= $di["request"];
Argumen dapat dilewatkan ke konstruktor dengan menambahkan parameter array ke metode “get”:
Phalcon\Di mampu mengirim event ke EventsManager jika ada. Event dipicu menggunakan tipe “di”. Beberapa event ketika mengembalikan nilai boolean false dapat menghentikan operasi aktif. Event berikut didukung: Nama Event Dipicu Bisa stop Dipicu operasi? di beforeSer- Dipicu sebelum resolve service. Listener menerima nama service dan Tidak Lis- viceResolve parameter yang dilewatkan. teners afterSer- Dipicu sebelum resolve service. Listener menerima nama service, Tidak Lis- viceResolve instance dan parameter yang dilewatkan. teners
Service dapat didaftarkan sebagai “shared” services yang berarti bahwa mereka selalu bertindak sebagai singletons. Service diresolve untuk pertama kali, instance sama dikembalikan tiap kali konsumer meminta service dari kontainer:
// daftarkan service session sebagai "always shared" $di->setShared( "session", function () { $session= new SessionFiles();
$session->start();
return $session; } );
// Temukan service untuk pertama kali $session= $di->get("session");
// Mengembalikan objek yang sudah diciptakan pertama kali $session= $di->getSession();
Cara lain mendaftarkan shared service adalah melewatkan “true” sebagai parameter ketiga “set”:
// Daftarkan service session sebagai "always shared" $di->set( "session", function () { // ... }, true );
Ketika sebuah service tidak didaftarkan sebagai service berbagi dan anda ingin memastikan instance yang sama diakses tiap kali service diambil dari DI, anda dapat menggunakan metode ‘getShared’:
$request= $di->getShared("request");
Memanipulasi masing-masing Service
Setelah service didaftarkan dalam kontainer service, anda dapat mengambilnya untuk dimanipulasi secara terpisah:
// Daftarkan service "request" $di->set("request","Phalcon \\Http\\Request");
// Ambil service $requestService= $di->getService("request");
// Ubah definisi $requestService->setDefinition( function () { return new Request(); } );
// Ubah menjadi berbagi $requestService->setShared(true);
// Resolve service (mengembalikan instance Phalcon\Http\Request) $request= $requestService->resolve();
Menciptakan kelas melalui Service Container
Ketika anda meminta service ke kontainer service, jika ia tidak dapat menemukan service dengan nama sama ia akan mencoba memuat kelas dengan nama sama. Dengan perilaku ini kita dapat mengganti sembarang kelas dengan lainnya cuma dengan mendaftarkan service dengan nama itu:
// Daftarkan kontroler sebagai service $di->set( "IndexController", function () { $component= new Component();
return $component; }, true );
// Daftarkan kontroler sebagai service $di->set( "MyOtherComponent", function () { // Kembalikan komponen lain $component= new AnotherComponent();
return $component; } );
// Buat instance melalui service container $myComponent= $di->get("MyOtherComponent");
Anda dapat memanfaatkan ini, dengan selalu menciptakan kelas anda melalui service container (bahkan jika mereka tidak didaftarkan sebagai service). DI akan fallback ke autoloader yang valid yang akhirnya memuat kelas tersebut. Dengan melakukan ini, anda dapat mengganti sembarang kelas dimasa datang dengan mengimplementasi definisinya.
Jika sebuah kelas atau komponen memerlukan DI sendiri untuk menemukan service, DI dapat diinjeksi otomatis kedalam instance yang diciptakan, untuk melakukan ini, anda butuh mengimplementasi Phal- con\Di\InjectionAwareInterface dalam kelas anda:
public function setDi(DiInterface $di) { $this->_di= $di; }
public function getDi() { return $this->_di; } } lalu setelah service diresolve, $di akan dilewatkan ke setDi() otomatis:
// Daftarkan service $di->set("myClass","MyClass");
// Resolve service (Catatan: $myClass->setDi($di) dipanggil otomatis) $myClass= $di->get("myClass");
Mengelola service dalam file
Anda dapat mengelola lebih baik aplikasi anda dengan memindahkan pendaftaran service ke file terpisah daripada melakukan semua dalam bootstrap aplikasi:
$di->set( "router", function () { return include "../app/config/routes.php"; } );
Lalu dalam file (”../app/config/routes.php”) kembalikan objek yang diresolve:
Jika diperlukan anda dapat mengakses DI yang diciptakan terakhir dalam fungsi statik dengan cara berikut:
getSession(); } }
Factory Default DI
Meski katakter Phalcon yang terpisah (decoupled) menawarkan kita kebebasan dan fleksibilitas bagus, mungkin kita cuma ingin menggunakannya sebagai framework full-stack. Untuk mencapai ini, framework menyediakan varian Phalcon\Di yang disebut Phalcon\Di\FactoryDefault. Kelas ini otomatis mendaftarkan service yang cocok yang diga- bung dengan framework untuk menjadikannya framework lengkap (full-stack).
$di= new FactoryDefault();
Konvensi Nama Service
Meski anda dapat mendaftarkan service dengan nama yang anda mau, Phalcon punya beberapa konvensi penamaan yang memungkinkan ia mendapatkan service bawaan dengan benar ketika anda membutuhkannya.
Nama Service Keterangan Default Shared dispatcher Controllers Dispatching Service Phalcon\Mvc\Dispatcher Ya router Routing Service Phalcon\Mvc\Router Ya url URL Generator Service Phalcon\Mvc\Url Ya request HTTP Request Environment Service Phalcon\Http\Request Ya response HTTP Response Environment Service Phalcon\Http\Response Ya cookies HTTP Cookies Management Service Phalcon\Http\Response\Cookies Ya filter Input Filtering Service Phalcon\Filter Ya flash Flash Messaging Service Phalcon\Flash\Direct Ya flashSession Flash Session Messaging Service Phalcon\Flash\Session Ya session Session Service Phalcon\Session\Adapter\Files Ya eventsManager Events Management Service Phalcon\Events\Manager Ya db Low-Level Database Connection Phalcon\Db Ya Service security Security helpers Phalcon\Security Ya crypt Encrypt/Decrypt data Phalcon\Crypt Ya tag HTML generation helpers Phalcon\Tag Ya escaper Contextual Escaping Phalcon\Escaper Ya annotations Annotations Parser Phalcon\Annotations\Adapter\Memory Ya modelsManager Models Management Service Phalcon\Mvc\Model\Manager Ya modelsMetadata Models Meta-Data Service Phal- Ya con\Mvc\Model\MetaData\Memory transactionMan- Models Transaction Manager Service Phal- Ya ager con\Mvc\Model\Transaction\Manager modelsCache Cache backend for models cache None Tidak viewsCache Cache backend for views fragments None Tidak
Mengimplementasi DI anda sendiri
Interface Phalcon\DiInterface harus diimplementasi untuk menciptakan DI anda sendiri menggantikan yang sudah disediakan oleh Phalcon atau melengkapi yang sudah ada.
The MVC Architecture
Phalcon offers the object-oriented classes, necessary to implement the Model, View, Controller architecture (often referred to as MVC) in your application. This design pattern is widely used by other web frameworks and desktop applications. MVC benefits include: • Isolation of business logic from the user interface and the database layer • Making it clear where different types of code belong for easier maintenance If you decide to use MVC, every request to your application resources will be managed by the MVC architecture. Phalcon classes are written in C language, offering a high performance approach of this pattern in a PHP based application.
Models
A model represents the information (data) of the application and the rules to manipulate that data. Models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, each table in your
116 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 database will correspond to one model in your application. The bulk of your application’s business logic will be concentrated in the models. Learn more
Views
Views represent the user interface of your application. Views are often HTML files with embedded PHP code that perform tasks related solely to the presentation of the data. Views handle the job of providing data to the web browser or other tool that is used to make requests from your application. Learn more
Controllers
The controllers provide the “flow” between models and views. Controllers are responsible for processing the incoming requests from the web browser, interrogating the models for data, and passing that data on to the views for presentation. Learn more
Menggunakan Kontroler
Aksi adalah metode pada sebuah kontroler yang menangani request. Defaultnya semua metode publik pada sebuah kontroler dipetakan ke aksi dan dapat diakses menggunakan sebuah URL. Aksi bertanggung jawab menerjemahkan request dan menciptakan respon. Respon biasanya dalam bentuk view yang dirender, namun ada juga cara lain untuk menciptakan respon. Contoh, ketika anda mengakses sebuah URL seperti berikut: http://localhost/blog/posts/show/2015/the-post-title Phal- con secara bawaan akan memecah tiap bagian seperti berikut: Phalcon Directory blog Controller posts Action show Parameter 2015 Parameter the-post-title Di kasus ini, PostsController akan menangani request ini. Tidak ada lokasi khusus untuk meletakkan kontroler dalam aplikasi, ia dapat dimuat menggunakan autoloaders, sehingga anda bebas mengorganisasi kontroler sesuai kebutuhan. Kontroler harus memiliki akhiran “Controller” sementara aksi menggunakan akhiran “Action”. Contoh sebuah kon- troler adalah sebagai berikut:
Parameter URI tambahan didefinisi sebagai parameter aksi, sehingga mereka dapat diakses dengan mudah menggu- nakan variabel lokal. Sebuah kontroler bisa jadi diturunkan dari Phalcon\Mvc\Controller. Dengan melakukan ini, kontroler dapat memiliki akses mudah ke layanan aplikasi. Parameter tanpa nilai default ditangani seperlunya. Pengaturan nilai opsional untuk parameter dilakukan seperti biasa dalam PHP:
use Phalcon\Mvc\Controller;
class PostsController extends Controller { public function indexAction() {
}
public function showAction($year= 2015, $postTitle="some default title") {
} }
Parameter disalin dengan urutan sama ketika dilewatkan dalam sebuah route. Anda dapat memeroleh sembarang parameter dari namanya dengan cara berikut:
use Phalcon\Mvc\Controller;
class PostsController extends Controller { public function indexAction() {
}
public function showAction() { $year= $this->dispatcher->getParam("year"); $postTitle= $this->dispatcher->getParam("postTitle"); } }
Dispatch Loop
Dispatch loop akan dijalankan dalam Dispatcher sampai tidak ada aksi tersisa untuk dijalankan. Di contoh sebelumnya hanya satu aksi yang dijalankan. Kita akan melihat bagaimana forward() dapat menyediakan alir operasi yang lebih kompleks dalam dispatch loop, dengan mengarahkan eksekusi ke kontroler/aksi berbeda.
public function showAction($year, $postTitle) { $this->flash->error( "You don't have permission to access this area" );
// Arahkan alir ke aksi lain $this->dispatcher->forward( [ "controller" =>"users", "action" =>"signin", ] ); } }
Jika pengguna tidak memiliki izin untuk mengakses aksi tertentu maka mereka akan diarahkan ke kontroler Users dan aksi bernama signin.
}
public function signinAction() {
} }
Tidak ada batasan jumlah “forward” yang dapat anda miliki dalam aplikasi, selama mereka tidak menyebabkan ref- erensi sirkular, di mana dititik ini aplikasi akan dihentikan. Jika tidak ada aksi lain yang harus dikirim oleh dispatch loop, dispatcher otomatis memanggil lapisan view dalam MVC yang dikelola oleh Phalcon\Mvc\View.
Inisialiasi Kontroler
Phalcon\Mvc\Controller menawarkan metode initialize(), yang dijalankan pertama kali, sebelum semua aksi dieksekusi pada sebuah kontroler. Penggunaan metode __construct() tidak disarankan.
public function initialize() { $this->settings=[ "mySetting" =>"value", ]; }
public function saveAction() { if ($this->settings["mySetting"] ==="value"){ // ... } } }
Metode initialize() hanya dipanggil jika event ‘beforeExecuteRoute’ dieksekusi dengan sukses. Ini mencegah kode aplikasi dalam initializer tidak dapat dieksekusi tanpa otorisasi. Jika anda ingin menjalankan kode inisialiasi tepat setelah menciptakan objek kontroler anda dapat mengimplementasi metode onConstruct():
Ketahui bahwa metode onConstruct() dijalankan bahkan bila aksi yang harus dijalankan tidak ada dalam kontroler atau user tidak punya akses ke sana (berdasarkan kontrol akses kustom yang disediakan oleh developer).
Menginjeksi Services
Jika sebuah kontroler diturunkan dari Phalcon\Mvc\Controller maka mudah untuk mengakses service container dalam aplikasi. Contoh, jika kita mendaftarkan sebuah service seperti ini:
$di= new Di();
$di->set( "storage", function () { return new Storage( "/some/directory" ); },
Jika anda menggunakan Phalcon sebagai sebuah full-stack framework, anda dapat membaca service bawaan yang disediakan dalam framework.
Request dan Response
Diasumsikan framework menyediakan sejumlah service yang telah terdaftar. Kita menjelaskan bagaimana berinter- aksi dengan lingkungan HTTP. Service “request” mengandung instance Phalcon\Http\Request dan “response” berisi Phalcon\Http\Response mewakili apa yang akan dikirim kembali ke klien.
}
public function saveAction() { // Uji apakah request dibuat dengan POST if ($this->request->isPost()) { // Akses data POST $customerName= $this->request->getPost("name"); $customerBorn= $this->request->getPost("born");
Objek response biasanya tidak digunakan secara langsung, ia dibuat sebelum eksekusi aksi, kadang kala - seperti dalam event afterDispatch - cukup berguna bila response dapat diakses langsung:
}
public function notFoundAction() { // Kirim response header HTTP 404 $this->response->setStatusCode(404,"Not Found"); } }
Pelajari lebih lanjut tentang lingkungan HTTP di artikel request dan response.
Data Session
Session membantu kita mengelola data persisten antar request. Anda dapat mengakses Phalcon\Session\Bag dari sembarang kontroler untuk membungkus data yang harus dibuat persisten.
persistent->name="Michael"; }
public function welcomeAction() { echo "Welcome,", $this->persistent->name; } }
Menggunakan Service sebagai Kontroler
Service dapat bertindak sebagai kontroler, kelas kontroler selalu diminta dari service container. Dengan demikian, tiap kelas lain yang terdaftar dengan nama sama dapat dengan mudah mengganti sebuah kontroler:
// Daftarkan kontroler sebagai service $di->set( "IndexController", function () { $component= new Component();
return $component; } );
// Daftarkan kontroler dengan namespace sebagai service $di->set( "Backend\\Controllers\\IndexController", function () { $component= new Component();
return $component; } );
Event dalam Kontroler
Kontroler otomatis bertindak sebagai listener untuk dispatcher event, mengimplementasi metode dengan nama tersebut memungkinkan anda untuk mengimplementasi hook point sebelum/sesudah aksi dieksekusi:
getActionName() ==="save"){ $this->flash->error( "You don't have permission to save posts" );
A model represents the information (data) of the application and the rules to manipulate that data. Models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, each table in your database will correspond to one model in your application. The bulk of your application’s business logic will be concentrated in the models. Phalcon\Mvc\Model is the base for all models in a Phalcon application. It provides database independence, basic CRUD functionality, advanced finding capabilities, and the ability to relate models to one another, among other ser- vices. Phalcon\Mvc\Model avoids the need of having to use SQL statements because it translates methods dynamically to the respective database engine operations. Models are intended to work with the database on a high layer of abstraction. If you need to work with databases at a lower level check out the Phalcon\Db component documentation.
Creating Models
A model is a class that extends from Phalcon\Mvc\Model. Its class name should be in camel case notation:
}
If you’re using PHP 5.4/5.5 it is recommended you declare each column that makes part of the model in order to save memory and reduce the memory allocation. By default, the model “Store\Toys\RobotParts” will refer to the table “robot_parts”. If you want to manually specify another name for the mapping table, you can use the setSource() method:
setSource("toys_robot_parts"); } }
The model RobotParts now maps to “toys_robot_parts” table. The initialize() method aids in setting up the model with a custom behavior i.e. a different table.
The initialize() method is only called once during the request, it’s intended to perform initializations that apply for all instances of the model created within the application. If you want to perform initialization tasks for every instance created you can use the onConstruct() method:
Public properties vs. Setters/Getters
Models can be implemented with properties of public scope, meaning that each property can be read/updated from any part of the code that has instantiated that model class without any restrictions:
public $name;
public $price; }
By using getters and setters you can control which properties are visible publicly perform various transformations to the data (which would be impossible otherwise) and also add validation rules to the data stored in the object:
public function setName($name) { // The name is too short? if (strlen($name)< 10){ throw new InvalidArgumentException( "The name is too short" ); }
$this->name= $name; }
public function getName() { return $this->name; }
public function setPrice($price) { // Negative prices aren't allowed if ($price<0){ throw new InvalidArgumentException( "Price can't be negative" ); }
$this->price= $price; }
public function getPrice() { // Convert the value to double before be used return (double) $this->price; } }
Public properties provide less complexity in development. However getters/setters can heavily increase the testability, extensibility and maintainability of applications. Developers can decide which strategy is more appropriate for the application they are creating. The ORM is compatible with both schemes of defining properties. Underscores in property names can be problematic when using getters and setters. If you use underscores in your property names, you must still use camel case in your getter/setter declarations for use with magic methods. (e.g. $model->getPropertyName instead of $model->getProperty_name, $model- >findByPropertyName instead of $model->findByProperty_name, etc.). As much of the system expects camel case, and underscores are commonly removed, it is recommended to name your properties in the manner shown throughout the documentation. You can use a column map (as described above) to ensure proper mapping of your properties to their database counterparts.
Every instance of a model represents a row in the table. You can easily access record data by reading object properties. For example, for a table “robots” with the records:
mysql> select * from robots; +----+------+------+------+ | id | name | type | year | +----+------+------+------+ |1 | Robotina | mechanical | 1972| |2 | Astro Boy | mechanical | 1952| |3 | Terminator | cyborg | 2029| +----+------+------+------+ 3 rows in set(0.00 sec)
You could find a certain record by its primary key and then print its name:
use Store\Toys\Robots;
// Find record with id = 3 $robot= Robots::findFirst(3);
// Prints "Terminator" echo $robot->name;
Once the record is in memory, you can make modifications to its data and then save changes:
use Store\Toys\Robots;
$robot= Robots::findFirst(3);
$robot->name="RoboCop";
$robot->save();
As you can see, there is no need to use raw SQL statements. Phalcon\Mvc\Model provides high database abstraction for web applications.
Finding Records
Phalcon\Mvc\Model also offers several methods for querying records. The following examples will show you how to query one or more records from a model:
use Store\Toys\Robots;
// How many robots are there? $robots= Robots::find(); echo "There are", count($robots)," \n";
// How many mechanical robots are there? $robots= Robots::find("type = 'mechanical'");
// Get and print virtual robots ordered by name $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", ] ); foreach ($robots as $robot){ echo $robot->name," \n"; }
// Get first 100 virtual robots ordered by name $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", "limit" => 100, ] ); foreach ($robots as $robot){ echo $robot->name," \n"; }
If you want find record by external data (such as user input) or variable data you must use Binding Parameters. You could also use the findFirst() method to get only the first record matching the given criteria:
// What's the first robot in robots table? $robot= Robots::findFirst(); echo "The robot name is", $robot->name," \n";
// What's the first mechanical robot in robots table? $robot= Robots::findFirst("type = 'mechanical'"); echo "The first mechanical robot name is", $robot->name," \n";
// Get first virtual robot ordered by name $robot= Robots::findFirst( [ "type = 'virtual'", "order" =>"name", ] ); echo "The first virtual robot name is", $robot->name," \n";
Both find() and findFirst() methods accept an associative array specifying the search criteria:
The available query options are: Pa- Description Example ram- eter con- Search conditions for the find operation. Is used to extract only "conditions" => "name di- those records that fulfill a specified criterion. By default LIKE 'steve%'" tions Phalcon\Mvc\Model assumes the first parameter are the conditions. columnsReturn specific columns instead of the full columns in the model. "columns" => "id, name" When using this option an incomplete object is returned bind Bind is used together with options, by replacing placeholders and "bind" => ["status" => escaping values thus increasing security "A", "type" => "some-time"] bind- When binding parameters, you can use this parameter to define "bindTypes" => Types additional casting to the bound parameters increasing even more [Column::BIND_PARAM_STR, the security Column::BIND_PARAM_INT] or- Is used to sort the resultset. Use one or more fields separated by "order" => "name DESC, der commas. status" limit Limit the results of the query to results to certain range "limit" => 10 off- Offset the results of the query by a certain amount "offset" => 5 set group Allows to collect data across multiple records and group the "group" => "name, results by one or more columns status" for_updateWith this option, Phalcon\Mvc\Model reads the latest available "for_update" => true data, setting exclusive locks on each row it reads shared_lockWith this option, Phalcon\Mvc\Model reads the latest available "shared_lock" => true data, setting shared locks on each row it reads cache Cache the resultset, reducing the continuous access to the "cache" => ["lifetime" relational system => 3600, "key" => "my-find-key"] hy- Sets the hydration strategy to represent each returned record in the "hydration" => dra- result Resultset::HYDRATE_OBJECTS tion If you prefer, there is also available a way to create queries in an object-oriented way, instead of using an array of parameters:
The static method query() returns a Phalcon\Mvc\Model\Criteria object that is friendly with IDE autocompleters. All the queries are internally handled as PHQL queries. PHQL is a high-level, object-oriented and SQL-like lan- guage. This language provide you more features to perform queries like joining other models, define groupings, add aggregations etc. Lastly, there is the findFirstBy() method. This method expands on the findFirst() method mentioned earlier. It allows you to quickly perform a retrieval from a table by using the property name in the method itself and passing it a parameter that contains the data you want to search for in that column. An example is in order, so taking our Robots model mentioned earlier:
namespace Store\Toys;
use Phalcon\Mvc\Model;
class Robots extends Model { public $id;
public $name;
public $price; }
We have three properties to work with here: $id, $name and $price. So, let’s say you want to retrieve the first record in the table with the name ‘Terminator’. This could be written like:
use Store\Toys\Robots;
$name="Terminator";
$robot= Robots::findFirstByName($name);
if ($robot){ echo "The first robot with the name". $name." cost". $robot->price."."; } else { echo "There were no robots found in our table with the name". $name."."; }
Notice that we used ‘Name’ in the method call and passed the variable $name to it, which contains the name we are looking for in our table. Notice also that when we find a match with our query, all the other properties are available to us as well.
While findFirst() returns directly an instance of the called class (when there is data to be returned), the find() method returns a Phalcon\Mvc\Model\Resultset\Simple. This is an object that encapsulates all the functionality a resultset has like traversing, seeking specific records, counting, etc. These objects are more powerful than standard arrays. One of the greatest features of the Phalcon\Mvc\Model\Resultset is that at any time there is only one record in memory. This greatly helps in memory management especially when working with large amounts of data.
// Get all robots $robots= Robots::find();
// Traversing with a foreach foreach ($robots as $robot){ echo $robot->name," \n"; }
// Traversing with a while $robots->rewind(); while ($robots->valid()) { $robot= $robots->current();
echo $robot->name," \n";
$robots->next(); }
// Count the resultset echo count($robots);
// Alternative way to count the resultset echo $robots->count();
// Move the internal cursor to the third robot $robots->seek(2);
$robot= $robots->current();
// Access a robot by its position in the resultset $robot= $robots[5];
// Check if there is a record in certain position if (isset($robots[3])) { $robot= $robots[3]; }
// Get the first record in the resultset $robot= $robots->getFirst();
// Get the last record $robot= $robots->getLast();
Phalcon’s resultsets emulate scrollable cursors, you can get any row just by accessing its position, or seeking the internal pointer to a specific position. Note that some database systems don’t support scrollable cursors, this forces to re-execute the query in order to rewind the cursor to the beginning and obtain the record at the requested position. Similarly, if a resultset is traversed several times, the query must be executed the same number of times. As storing large query results in memory could consume many resources, resultsets are obtained from the database in chunks of 32 rows - reducing the need to re-execute the request in several cases. Note that resultsets can be serialized and stored in a cache backend. Phalcon\Cache can help with that task. However, serializing data causes Phalcon\Mvc\Model to retrieve all the data from the database in an array, thus consuming more memory while this process takes place.
// Query all records from model parts $parts= Parts::find();
// Store the resultset into a file file_put_contents( "cache.txt", serialize($parts) );
// Get parts from file $parts= unserialize( file_get_contents("cache.txt") );
// Traverse the parts foreach ($parts as $part){ echo $part->id; }
Filtering Resultsets
The most efficient way to filter data is setting some search criteria, databases will use indexes set on tables to return data faster. Phalcon additionally allows you to filter the data using PHP using any resource that is not available in the database:
$customers= Customers::find();
$customers= $customers->filter( function ($customer){ // Return only customers with a valid e-mail if (filter_var($customer->email, FILTER_VALIDATE_EMAIL)) { return $customer; } } );
Bound parameters are also supported in Phalcon\Mvc\Model. You are encouraged to use this methodology so as to eliminate the possibility of your code being subject to SQL injection attacks. Both string and integer placeholders are supported. Binding parameters can simply be achieved as follows:
use Store\Toys\Robots;
// Query robots binding parameters with string placeholders // Parameters whose keys are the same as placeholders $robots= Robots::find( [ "name = :name: AND type = :type:", "bind" =>[ "name" =>"Robotina", "type" =>"maid", ], ] );
// Query robots binding parameters with integer placeholders $robots= Robots::find( [ "name = ?1 AND type = ?2", "bind" =>[ 1 =>"Robotina", 2 =>"maid", ], ] );
// Query robots binding parameters with both string and integer placeholders // Parameters whose keys are the same as placeholders $robots= Robots::find( [ "name = :name: AND type = ?1", "bind" =>[ "name" =>"Robotina", 1 =>"maid", ], ] );
When using numeric placeholders, you will need to define them as integers i.e. 1 or 2. In this case “1” or “2” are considered strings and not numbers, so the placeholder could not be successfully replaced. Strings are automatically escaped using PDO. This function takes into account the connection charset, so its recom- mended to define the correct charset in the connection parameters or in the database configuration, as a wrong charset will produce undesired effects when storing or retrieving data. Additionally you can set the parameter “bindTypes”, this allows defining how the parameters should be bound accord- ing to its data type:
// Query robots binding parameters with string placeholders $robots= Robots::find( [ "name = :name: AND year = :year:", "bind" => $parameters, "bindTypes" => $types, ] );
Since the default bind-type is Phalcon\Db\Column::BIND_PARAM_STR, there is no need to spec- ify the “bindTypes” parameter if all of the columns are of that type. If you bind arrays in bound parameters, keep in mind, that keys must be numbered from zero:
Bound parameters are available for all query methods such as find() and findFirst() but also the calculation methods like count(), sum(), average() etc. If you’re using “finders”, bound parameters are automatically used for you:
// Implicit query using bound parameters $robots= Robots::findByName("Ultron");
Initializing/Preparing fetched records
May be the case that after obtaining a record from the database is necessary to initialise the data before being used by the rest of the application. You can implement the afterFetch() method in a model, this event will be executed just after create the instance and assign the data to it:
public $name;
public $status;
public function beforeSave() { // Convert the array into a string $this->status= join(",", $this->status); }
public function afterFetch() { // Convert the string to an array $this->status= explode(",", $this->status); }
public function afterSave() { // Convert the string to an array $this->status= explode(",", $this->status); } }
If you use getters/setters instead of/or together with public properties, you can initialize the field once it is accessed:
use Phalcon\Mvc\Model; class Robots extends Model { public $id;
public $name;
public $status;
public function getStatus() { return explode(",", $this->status); } }
Generating Calculations
Calculations (or aggregations) are helpers for commonly used functions of database systems such as COUNT, SUM, MAX, MIN or AVG. Phalcon\Mvc\Model allows to use these functions directly from the exposed methods. Count examples:
// How many employees are? $rowcount= Employees::count();
// How many different areas are assigned to employees? $rowcount= Employees::count( [ "distinct" =>"area", ] );
// How many employees are in the Testing area? $rowcount= Employees::count( "area = 'Testing'" );
// Count employees grouping results by their area $group= Employees::count( [ "group" =>"area", ] ); foreach ($group as $row){ echo "There are", $row->rowcount," in", $row->area; }
// Count employees grouping by their area and ordering the result by count $group= Employees::count( [ "group" =>"area", "order" =>"rowcount", ]
// How much are the salaries of all employees? $total= Employees::sum( [ "column" =>"salary", ] );
// How much are the salaries of all employees in the Sales area? $total= Employees::sum( [ "column" =>"salary", "conditions" =>"area = 'Sales'", ] );
// Generate a grouping of the salaries of each area $group= Employees::sum( [ "column" =>"salary", "group" =>"area", ] ); foreach ($group as $row){ echo "The sum of salaries of the", $row->area," is", $row->sumatory; }
// Generate a grouping of the salaries of each area ordering // salaries from higher to lower $group= Employees::sum( [ "column" =>"salary", "group" =>"area", "order" =>"sumatory DESC", ] );
// What is the average salary for all employees? $average= Employees::average( [ "column" =>"salary", ] );
// What is the average salary for the Sales's area employees? $average= Employees::average( [ "column" =>"salary", "conditions" =>"area = 'Sales'", ] );
The Phalcon\Mvc\Model::save() method allows you to create/update records according to whether they al- ready exist in the table associated with a model. The save method is called internally by the create and update methods of Phalcon\Mvc\Model. For this to work as expected it is necessary to have properly defined a primary key in the entity to determine whether a record should be updated or created. Also the method executes associated validators, virtual foreign keys and events that are defined in the model:
$robot= new Robots();
$robot->type="mechanical"; $robot->name="Astro Boy"; $robot->year= 1952; if ($robot->save() === false){ echo "Umh, We can't store robots right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "Great, a new robot was saved successfully!"; }
An array could be passed to “save” to avoid assign every column manually. Phalcon\Mvc\Model will check if there are setters implemented for the columns passed in the array giving priority to them instead of assign directly the values of the attributes:
Values assigned directly or via the array of attributes are escaped/sanitized according to the related attribute data type. So you can pass an insecure array without worrying about possible SQL injections:
Without precautions mass assignment could allow attackers to set any database column’s value. Only use this feature if you want to permit a user to insert/update every column in the model, even if those fields are not in the submitted form. You can set an additional parameter in ‘save’ to set a whitelist of fields that only must taken into account when doing the mass assignment:
$robot= new Robots();
$robot->save( $_POST, [ "name", "type", ] );
Create/Update with Confidence
When an application has a lot of competition, we could be expecting create a record but it is actually updated. This could happen if we use Phalcon\Mvc\Model::save() to persist the records in the database. If we want to be absolutely sure that a record is created or updated, we can change the save() call with create() or update():
These methods “create” and “update” also accept an array of values as parameter.
Deleting Records
The Phalcon\Mvc\Model::delete() method allows to delete a record. You can use it as follows:
$robot= Robots::findFirst(11); if ($robot !== false){ if ($robot->delete() === false){ echo "Sorry, we can't delete the robot right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "The robot was deleted successfully!"; } }
You can also delete many records by traversing a resultset with a foreach:
$robots= Robots::find( "type = 'mechanical'" ); foreach ($robots as $robot){ if ($robot->delete() === false){ echo "Sorry, we can't delete the robot right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "The robot was deleted successfully!"; } }
The following events are available to define custom business rules that can be executed when a delete operation is performed: Operation Name Can stop operation? Explanation Deleting beforeDelete YES Runs before the delete operation is made Deleting afterDelete NO Runs after the delete operation was made With the above events can also define business rules in the models:
status ==="A"){ echo "The robot is active, it can't be deleted";
return false; }
return true; } }
Model Relationships
Relationships between Models
There are four types of relationships: one-on-one, one-to-many, many-to-one and many-to-many. The relationship may be unidirectional or bidirectional, and each can be simple (a one to one model) or more complex (a combination of models). The model manager manages foreign key constraints for these relationships, the definition of these helps referential integrity as well as easy and fast access of related records to a model. Through the implementation of relations, it is easy to access data in related models from each record in a uniform way.
Unidirectional relationships
Unidirectional relations are those that are generated in relation to one another but not vice versa.
Bidirectional relations
The bidirectional relations build relationships in both models and each model defines the inverse relationship of the other.
Defining relationships
In Phalcon, relationships must be defined in the initialize() method of a model. The methods belongsTo(), hasOne(), hasMany() and hasManyToMany() define the relationship between one or more fields from the current model to fields in another model. Each of these methods requires 3 parameters: local fields, referenced model, referenced fields. Method Description hasMany Defines a 1-n relationship hasOne Defines a 1-1 relationship belongsTo Defines a n-1 relationship hasManyToMany Defines a n-n relationship
The following schema shows 3 tables whose relations will serve us as an example regarding relationships:
CREATE TABLE `robots`( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(70) NOT NULL, `type` varchar(32) NOT NULL, `year` int(11) NOT NULL, PRIMARY KEY (`id`) );
CREATE TABLE `robots_parts`( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `robots_id` int(10) NOT NULL, `parts_id` int(10) NOT NULL, `created_at` DATE NOT NULL, PRIMARY KEY (`id`), KEY `robots_id`(`robots_id`), KEY `parts_id`(`parts_id`) );
CREATE TABLE `parts`( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(70) NOT NULL, PRIMARY KEY (`id`) );
• The model “Robots” has many “RobotsParts”. • The model “Parts” has many “RobotsParts”. • The model “RobotsParts” belongs to both “Robots” and “Parts” models as a many-to-one relation. • The model “Robots” has a relation many-to-many to “Parts” through “RobotsParts”. Check the EER diagram to understand better the relations: The models with their relations could be implemented as follows:
public $name;
public function initialize() { $this->hasMany( "id", "RobotsParts", "robots_id" ); } }
The first parameter indicates the field of the local model used in the relationship; the second indicates the name of the referenced model and the third the field name in the referenced model. You could also use arrays to define multiple fields in the relationship. Many to many relationships require 3 models and define the attributes involved in the relationship:
use Phalcon\Mvc\Model; class Robots extends Model { public $id;
public $name;
public function initialize() { $this->hasManyToMany( "id", "RobotsParts", "robots_id","parts_id", "Parts", "id" ); } }
Taking advantage of relationships
When explicitly defining the relationships between models, it is easy to find related records for a particular record.
$robot= Robots::findFirst(2); foreach ($robot->robotsParts as $robotPart){ echo $robotPart->parts->name," \n"; }
Phalcon uses the magic methods __set/__get/__call to store or retrieve related data using relationships. By accessing an attribute with the same name as the relationship will retrieve all its related record(s).
$robot= Robots::findFirst();
// All the related records in RobotsParts $robotsParts= $robot->robotsParts;
If the called method has a “get” prefix Phalcon\Mvc\Model will return a findFirst()/find() result. The follow- ing example compares retrieving related results with using magic methods and without:
$robot= Robots::findFirst(2);
// Robots model has a 1-n (hasMany) // relationship to RobotsParts then $robotsParts= $robot->robotsParts;
// Only parts that match conditions $robotsParts= $robot->getRobotsParts( [ "created_at = :date:", "bind" =>[ "date" =>"2015-03-15" ] ] );
$robotPart= RobotsParts::findFirst(1);
// RobotsParts model has a n-1 (belongsTo) // relationship to RobotsParts then $robot= $robotPart->robots;
Getting related records manually:
$robot= Robots::findFirst(2);
// Robots model has a 1-n (hasMany) // relationship to RobotsParts, then $robotsParts= RobotsParts::find( [ "robots_id = :id:", "bind" =>[ "id" => $robot->id, ] ] );
// RobotsParts model has a n-1 (belongsTo) // relationship to RobotsParts then $robot= Robots::findFirst( [ "id = :id:", "bind" =>[ "id" => $robotPart->robots_id, ] ] );
The prefix “get” is used to find()/findFirst() related records. Depending on the type of relation it will use find() or findFirst(): Type Description Implicit Method Belongs-To Returns a model instance of the related record directly findFirst Has-One Returns a model instance of the related record directly findFirst Has-Many Returns a collection of model instances of the referenced model find Has-Many- Returns a collection of model instances of the referenced model, it implicitly does (complex to-Many ‘inner joins’ with the involved models query) You can also use the “count” prefix to return an integer denoting the count of the related records:
$robot= Robots::findFirst(2); echo "The robot has", $robot->countRobotsParts()," parts \n";
Aliasing Relationships
To explain better how aliases work, let’s check the following example: The “robots_similar” table has the function to define what robots are similar to others: mysql> desc robots_similar; +------+------+------+-----+------+------+ | Field | Type | Null | Key | Default | Extra | +------+------+------+-----+------+------+ | id | int(10) unsigned | NO | PRI | NULL | auto_increment | | robots_id | int(10) unsigned | NO | MUL | NULL | | | similar_robots_id | int(10) unsigned | NO | | NULL | |
Since both relations point to the same model (Robots), obtain the records related to the relationship could not be clear:
$robotsSimilar= RobotsSimilar::findFirst();
// Returns the related record based on the column (robots_id) // Also as is a belongsTo it's only returning one record // but the name 'getRobots' seems to imply that return more than one $robot= $robotsSimilar->getRobots();
With the aliasing we can get the related records easily:
$robotsSimilar= RobotsSimilar::findFirst();
// Returns the related record based on the column (robots_id) $robot= $robotsSimilar->getRobot(); $robot= $robotsSimilar->robot;
// Returns the related record based on the column (similar_robots_id) $similarRobot= $robotsSimilar->getSimilarRobot(); $similarRobot= $robotsSimilar->similarRobot;
Magic Getters vs. Explicit methods
Most IDEs and editors with auto-completion capabilities can not infer the correct types when using magic getters, instead of use the magic getters you can optionally define those methods explicitly with the corresponding docblocks helping the IDE to produce a better auto-completion:
namespace Store\Toys; use Phalcon\Mvc\Model; class Robots extends Model { public $id;
public $name;
public function initialize() { $this->hasMany( "id", "RobotsParts", "robots_id" ); }
/** * Return the related "robots parts" * * @return \RobotsParts[] */ public function getRobotsParts($parameters= null) { return $this->getRelated("RobotsParts", $parameters); } }
Virtual Foreign Keys
By default, relationships do not act like database foreign keys, that is, if you try to insert/update a value without having a valid value in the referenced model, Phalcon will not produce a validation message. You can modify this behavior by adding a fourth parameter when defining a relationship. The RobotsPart model can be changed to demonstrate this feature:
public $robots_id;
public $parts_id;
public function initialize() { $this->belongsTo( "robots_id", "Store\\Toys\\Robots", "id", [
$this->belongsTo( "parts_id", "Parts", "id", [ "foreignKey" =>[ "message" =>"The part_id does not exist on the Parts model" ] ] ); } }
If you alter a belongsTo() relationship to act as foreign key, it will validate that the values inserted/updated on those fields have a valid value on the referenced model. Similarly, if a hasMany()/hasOne() is altered it will validate that the records cannot be deleted if that record is used on a referenced model.
hasMany( "id", "RobotsParts", "parts_id", [ "foreignKey" =>[ "message" =>"The part cannot be deleted because other robots are
˓→using it", ] ] ); } }
A virtual foreign key can be set up to allow null values as follows:
$album->name="The One"; $album->artist= $artist; // Assign the artist $album->year= 2008;
// Save both records $album->save();
Saving a record and its related records in a has-many relation:
// Get an existing artist $artist= Artists::findFirst( "name = 'Shinichi Osawa'" );
// Create an album $album= new Albums();
$album->name="The One"; $album->artist= $artist;
$songs= [];
// Create a first song $songs[0]= new Songs(); $songs[0]->name="Star Guitar"; $songs[0]->duration="5:54";
// Create a second song $songs[1]= new Songs(); $songs[1]->name="Last Days"; $songs[1]->duration="4:29";
// Assign the songs array $album->songs= $songs;
// Save the album + its songs $album->save();
Saving the album and the artist at the same time implicitly makes use of a transaction so if anything goes wrong with saving the related records, the parent will not be saved either. Messages are passed back to the user for information regarding any errors. Note: Adding related entities by overloading the following methods is not possible: • Phalcon\Mvc\Model::beforeSave()
• Phalcon\Mvc\Model::beforeCreate() • Phalcon\Mvc\Model::beforeUpdate() You need to overload Phalcon\Mvc\Model::save() for this to work from within a model.
Operations over Resultsets
If a resultset is composed of complete objects, the resultset is in the ability to perform operations on the records obtained in a simple manner:
Updating related records
Instead of doing this:
$parts= $robots->getParts();
foreach ($parts as $part){ $part->stock= 100; $part->updated_at= time();
if ($part->update() === false){ $messages= $part->getMessages();
Models allow you to implement events that will be thrown while performing an insert/update/delete which can be used to define business rules. The following are the events supported by Phalcon\Mvc\Model and their order of execution: Opera- Name Can stop Explanation tion operation? Insert- beforeValida- YES Is executed before the fields are validated for not nulls/empty ing/Updatingtion strings or foreign keys Inserting beforeValida- YES Is executed before the fields are validated for not nulls/empty tionOnCreate strings or foreign keys when an insertion operation is being made Updating beforeValida- YES Is executed before the fields are validated for not nulls/empty tionOnUpdate strings or foreign keys when an updating operation is being made Insert- onValidation- YES Is executed after an integrity validator fails ing/UpdatingFails (already stopped) Inserting afterValida- YES Is executed after the fields are validated for not nulls/empty strings tionOnCreate or foreign keys when an insertion operation is being made Updating afterValida- YES Is executed after the fields are validated for not nulls/empty strings tionOnUpdate or foreign keys when an updating operation is being made Insert- afterValida- YES Is executed after the fields are validated for not nulls/empty strings ing/Updatingtion or foreign keys Insert- beforeSave YES Runs before the required operation over the database system ing/Updating Updating beforeUpdate YES Runs before the required operation over the database system only when an updating operation is being made Inserting beforeCreate YES Runs before the required operation over the database system only when an inserting operation is being made Updating afterUpdate NO Runs after the required operation over the database system only when an updating operation is being made Inserting afterCreate NO Runs after the required operation over the database system only when an inserting operation is being made Insert- afterSave NO Runs after the required operation over the database system ing/Updating
Implementing Events in the Model’s class
The easier way to make a model react to events is to implement a method with the same name of the event in the model’s class:
Events can be used to assign values before performing an operation, for example:
created_at= date("Y-m-d H:i:s"); }
public function beforeUpdate() { // Set the modification date $this->modified_in= date("Y-m-d H:i:s"); } }
Using a custom Events Manager
Additionally, this component is integrated with Phalcon\Events\Manager, this means we can create listeners that run when an event is triggered.
// Attach an anonymous function as a listener for "model" events $eventsManager->attach( "model:beforeSave", function (Event $event, $robot){ if ($robot->name ==="Scooby Doo"){ echo "Scooby Doo isn't a robot!";
return false; }
return true; } );
// Attach the events manager to the event $this->setEventsManager($eventsManager); }
In the example given above, the Events Manager only acts as a bridge between an object and a listener (the anonymous function). Events will be fired to the listener when ‘robots’ are saved:
$robot= new Robots();
$robot->name="Scooby Doo"; $robot->year= 1969;
$robot->save();
If we want all objects created in our application use the same EventsManager, then we need to assign it to the Models Manager:
// Registering the modelsManager service $di->setShared( "modelsManager", function () { $eventsManager= new EventsManager();
// Attach an anonymous function as a listener for "model" events $eventsManager->attach( "model:beforeSave", function (Event $event, $model){ // Catch events produced by the Robots model if (get_class($model) ==="Store \\Toys\\Robots"){ if ($model->name ==="Scooby Doo"){ echo "Scooby Doo isn't a robot!";
return false; } }
return true; } );
// Setting a default EventsManager $modelsManager= new ModelsManager();
$modelsManager->setEventsManager($eventsManager);
return $modelsManager; } );
If a listener returns false that will stop the operation that is executing currently.
When using high-level abstraction components such as Phalcon\Mvc\Model to access a database, it is difficult to understand which statements are finally sent to the database system. Phalcon\Mvc\Model is supported internally by Phalcon\Db. Phalcon\Logger interacts with Phalcon\Db, providing logging capabilities on the database abstraction layer, thus allowing us to log SQL statements as they happen.
$di->set( "db", function () { $eventsManager= new EventsManager();
$logger= new FileLogger("app/logs/debug.log");
// Listen all the database events $eventsManager->attach( "db:beforeQuery", function ($event, $connection) use ($logger){ $logger->log( $connection->getSQLStatement(), Logger::INFO ); } );
$robot->created_at="1956-07-21"; if ($robot->save() === false){ echo "Cannot save robot"; }
As above, the file app/logs/db.log will contain something like this:
[Mon, 30 Apr 12 13:47:18 -0500][DEBUG][Resource Id #77] INSERT INTO robots (name, created_at) VALUES ('Robby the Robot', '1956-07-21')
Profiling SQL Statements
Thanks to Phalcon\Db, the underlying component of Phalcon\Mvc\Model, it’s possible to profile the SQL statements generated by the ORM in order to analyze the performance of database operations. With this you can diagnose performance problems and to discover bottlenecks.
$di->set( "profiler", function () { return new ProfilerDb(); }, true );
$di->set( "db", function () use ($di){ $eventsManager= new EventsManager();
// Get a shared instance of the DbProfiler $profiler= $di->getProfiler();
// Listen all the database events $eventsManager->attach( "db", function ($event, $connection) use ($profiler){ if ($event->getType() ==="beforeQuery"){ $profiler->startProfile( $connection->getSQLStatement() ); }
if ($event->getType() ==="afterQuery"){ $profiler->stopProfile(); } } );
// Assign the eventsManager to the db adapter instance $connection->setEventsManager($eventsManager);
return $connection; } );
Profiling some queries:
// Send some SQL statements to the database Robots::find();
Robots::find( [ "order" =>"name", ] );
Robots::find( [ "limit" => 30, ] );
// Get the generated profiles from the profiler $profiles= $di->get("profiler")->getProfiles(); foreach ($profiles as $profile){ echo "SQL Statement:", $profile->getSQLStatement()," \n"; echo "Start Time:", $profile->getInitialTime()," \n"; echo "Final Time:", $profile->getFinalTime()," \n"; echo "Total Elapsed Time:", $profile->getTotalElapsedSeconds()," \n"; }
Each generated profile contains the duration in milliseconds that each instruction takes to complete as well as the generated SQL statement.
Model Behaviors
Behaviors are shared conducts that several models may adopt in order to re-use code, the ORM provides an API to implement behaviors in your models. Also, you can use the events and callbacks as seen before as an alternative to implement Behaviors with more freedom. A behavior must be added in the model initializer, a model can have zero or more behaviors:
public function initialize() { $this->addBehavior( new Timestampable( [ "beforeCreate" =>[ "field" =>"created_at", "format" =>"Y-m-d", ] ] ) ); } }
The following built-in behaviors are provided by the framework: Name Description Timestam- Allows to automatically update a model’s attribute saving the datetime when a record is created pable or updated SoftDelete Instead of permanently delete a record it marks the record as deleted changing the value of a flag column
Timestampable
This behavior receives an array of options, the first level key must be an event name indicating when the column must be assigned:
Each event can have its own options, ‘field’ is the name of the column that must be updated, if ‘format’ is a string it will be used as format of the PHP’s function date, format can also be an anonymous function providing you the free to generate any kind timestamp:
addBehavior( new Timestampable( [ "beforeCreate" =>[ "field" =>"created_at", "format" => function () { $datetime= new Datetime( new DateTimeZone("Europe/Stockholm") );
public function initialize() { $this->addBehavior( new SoftDelete( [ "field" =>"status", "value" => Users::DELETED, ] ) ); } }
This behavior accepts two options: ‘field’ and ‘value’, ‘field’ determines what field must be updated and ‘value’ the value to be deleted. Let’s pretend the table ‘users’ has the following data: mysql> select * from users; +----+------+------+ | id | name | status | +----+------+------+ |1 | Lana | N | |2 | Brandon | N | +----+------+------+ 2 rows in set(0.00 sec)
If we delete any of the two records the status will be updated instead of delete the record:
Users::findFirst(2)->delete();
The operation will result in the following data in the table: mysql> select * from users; +----+------+------+ | id | name | status | +----+------+------+ |1 | Lana | N | |2 | Brandon | D | +----+------+------+ 2 rows in set(0.01 sec)
Note that you need to specify the deleted condition in your queries to effectively ignore them as deleted records, this behavior doesn’t support that.
Creating your own behaviors
The ORM provides an API to create your own behaviors. A behavior must be a class implementing the Phal- con\Mvc\Model\BehaviorInterface. Also, Phalcon\Mvc\Model\Behavior provides most of the methods needed to ease the implementation of behaviors. The following behavior is an example, it implements the Blameable behavior which helps identify the user that is performed operations over a model:
{ // If the method is 'getSlug' convert the title if ($method ==="getSlug"){ return Tag::friendlyTitle($model->title); } } }
Call that method on a model that implements Sluggable returns a SEO friendly title:
$title= $post->getSlug();
Using Traits as behaviors
Starting from PHP 5.4 you can use Traits to re-use code in your classes, this is another way to implement custom behaviors. The following trait implements a simple version of the Timestampable behavior:
trait MyTimestampable { public function beforeCreate() { $this->created_at= date("r"); }
public function beforeUpdate() { $this->updated_at= date("r"); } }
Then you can use it in your model as follows:
use Phalcon\Mvc\Model;
class Products extends Model { use MyTimestampable; }
Models Metadata
To speed up development Phalcon\Mvc\Model helps you to query fields and constraints from tables related to models. To achieve this, Phalcon\Mvc\Model\MetaData is available to manage and cache table metadata. Sometimes it is necessary to get those attributes when working with models. You can get a metadata instance as follows:
// Get Phalcon\Mvc\Model\Metadata instance $metadata= $robot->getModelsMetaData();
// Get robots fields names $attributes= $metadata->getAttributes($robot); print_r($attributes);
// Get robots fields data types $dataTypes= $metadata->getDataTypes($robot); print_r($dataTypes);
Caching Metadata
Once the application is in a production stage, it is not necessary to query the metadata of the table from the database system each time you use the table. This could be done caching the metadata using any of the following adapters: AdapterDescription API Mem- This adapter is the default. The metadata is cached only during the request. When Phal- ory the request is completed, the metadata are released as part of the normal memory of con\Mvc\Model\MetaData\Memory the request. This adapter is perfect when the application is in development so as to refresh the metadata in each request containing the new and/or modified fields. Ses- This adapter stores metadata in the $_SESSION superglobal. This adapter is Phal- sion recommended only when the application is actually using a small number of con\Mvc\Model\MetaData\Session models. The metadata are refreshed every time a new session starts. This also requires the use of session_start() to start the session before using any models. Apc This adapter uses the Alternative PHP Cache (APC) to store the table metadata. Phal- You can specify the lifetime of the metadata with options. This is the most con\Mvc\Model\MetaData\Apc recommended way to store metadata when the application is in production stage. XCacheThis adapter uses XCache to store the table metadata. You can specify the lifetime Phal- of the metadata with options. This is the most recommended way to store metadata con\Mvc\Model\MetaData\Xcache when the application is in production stage. Files This adapter uses plain files to store metadata. By using this adapter the Phal- disk-reading is increased but the database access is reduced. con\Mvc\Model\MetaData\Files As other ORM’s dependencies, the metadata manager is requested from the services container:
$di["modelsMetadata"]= function () { // Create a metadata manager with APC $metadata= new ApcMetaData( [ "lifetime" => 86400, "prefix" =>"my-prefix", ] );
As mentioned above the default strategy to obtain the model’s metadata is database introspection. In this strategy, the information schema is used to know the fields in a table, its primary key, nullable fields, data types, etc. You can change the default metadata introspection in the following way:
$di["modelsMetadata"]= function () { // Instantiate a metadata adapter $metadata= new ApcMetaData( [ "lifetime" => 86400, "prefix" =>"my-prefix", ] );
// Set a custom metadata introspection strategy $metadata->setStrategy( new MyIntrospectionStrategy() );
return $metadata; };
Database Introspection Strategy
This strategy doesn’t require any customization and is implicitly used by all the metadata adapters.
Annotations Strategy
This strategy makes use of annotations to describe the columns in a model:
/** * @Column(type="string", length=70, nullable=false) */ public $name;
* @Column(type="string", length=32, nullable=false) */ public $type;
/** * @Column(type="integer", nullable=false) */ public $year; }
Annotations must be placed in properties that are mapped to columns in the mapped source. Properties without the @Column annotation are handled as simple class attributes. The following annotations are supported: Name Description Primary Mark the field as part of the table’s primary key Identity The field is an auto_increment/serial column Column This marks an attribute as a mapped column The annotation @Column supports the following parameters: Name Description type The column’s type (string, integer, decimal, boolean) length The column’s length if any nullable Set whether the column accepts null values or not The annotations strategy could be set up this way:
$di["modelsMetadata"]= function () { // Instantiate a metadata adapter $metadata= new ApcMetaData( [ "lifetime" => 86400, "prefix" =>"my-prefix", ] );
// Set a custom metadata database introspection $metadata->setStrategy( new StrategyAnnotations() );
return $metadata; };
Manual Metadata
Phalcon can obtain the metadata for each model automatically without the developer must set them manually using any of the introspection strategies presented above. The developer also has the option of define the metadata manually. This strategy overrides any strategy set in the metadata manager. New columns added/modified/removed to/from the mapped table must be added/modified/removed
170 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 also for everything to work properly. The following example shows how to define the metadata manually:
[ "id", "name", "type", "year", ],
// Every column part of the primary key MetaData::MODELS_PRIMARY_KEY =>[ "id", ],
// Every column that isn't part of the primary key MetaData::MODELS_NON_PRIMARY_KEY =>[ "name", "type", "year", ],
// Every column that doesn't allows null values MetaData::MODELS_NOT_NULL =>[ "id", "name", "type", ],
// Every column and their data types MetaData::MODELS_DATA_TYPES =>[ "id" => Column::TYPE_INTEGER, "name" => Column::TYPE_VARCHAR, "type" => Column::TYPE_VARCHAR, "year" => Column::TYPE_INTEGER, ],
// The columns that have numeric data types MetaData::MODELS_DATA_TYPES_NUMERIC =>[ "id" => true, "year" => true, ],
// The identity column, use boolean false if the model doesn't have // an identity column MetaData::MODELS_IDENTITY_COLUMN =>"id",
When a process performs multiple database operations, it might be important that each step is completed successfully so that data integrity can be maintained. Transactions offer the ability to ensure that all database operations have been executed successfully before the data is committed to the database. Transactions in Phalcon allow you to commit all operations if they were executed successfully or rollback all operations if something went wrong.
Manual Transactions
If an application only uses one connection and the transactions aren’t very complex, a transaction can be created by just moving the current connection into transaction mode and then commit or rollback the operation whether it is successful or not:
// The model failed to save, so rollback the transaction if ($robotPart->save() === false){ $this->db->rollback();
return; }
// Commit the transaction $this->db->commit(); } }
Implicit Transactions
Existing relationships can be used to store records and their related instances, this kind of operation implicitly creates a transaction to ensure that data is correctly stored:
Isolated transactions are executed in a new connection ensuring that all the generated SQL, virtual foreign key checks and business rules are isolated from the main connection. This kind of transaction requires a transaction manager that globally manages each transaction created ensuring that they are correctly rolled back/committed before ending the request:
// Request a transaction $transaction= $manager->get();
Transactions are reused no matter where the transaction object is retrieved. A new transaction is generated only when a commit() or rollback() is performed. You can use the service container to create the global transaction manager for the entire application:
$di->setShared( "transactions", function () { return new TransactionManager(); } );
public function saveAction() { // Obtain the TransactionsManager from the services container $manager= $this->di->getTransactions();
// Or $manager= $this->transactions;
// Request a transaction $transaction= $manager->get();
// ... } }
While a transaction is active, the transaction manager will always return the same transaction across the application.
Validating Models
Validating Data Integrity
Phalcon\Mvc\Model provides several events to validate data and implement business rules. The special “validation” event allows us to call built-in validators over the record. Phalcon exposes a few built-in validators that can be used at this stage of validation. The following example shows how to use it:
new Uniqueness( [ "message" =>"The robot name must be unique", ] ) );
return $this->validate($validator); } }
The above example performs a validation using the built-in validator “InclusionIn”. It checks the value of the field “type” in a domain list. If the value is not included in the method then the validator will fail and return false. For more information on validators, see the Validation documentation. The idea of creating validators is make them reusable between several models. A validator can also be as simple as:
type ==="Old"){ $message= new Message( "Sorry, old robots are not allowed anymore", "type", "MyType" );
$this->appendMessage($message);
return false; }
return true; } }
Validation Messages
Phalcon\Mvc\Model has a messaging subsystem that provides a flexible way to output or store the validation messages generated during the insert/update processes. Each message is an instance of Phalcon\Mvc\Model\Message and the set of messages generated can be retrieved with the getMessages() method. Each message provides extended information like the field name that generated the message or the message type:
Phalcon\Mvc\Model can generate the following types of validation messages: Type Description PresenceOf Generated when a field with a non-null attribute on the database is trying to insert/update a null value ConstraintViola- Generated when a field part of a virtual foreign key is trying to insert/update a value that tion doesn’t exist in the referenced model InvalidValue Generated when a validator failed because of an invalid value InvalidCreateAt- Produced when a record is attempted to be created but it already exists tempt InvalidUp- Produced when a record is attempted to be updated but it doesn’t exist dateAttempt The getMessages() method can be overridden in a model to replace/translate the default messages generated automatically by the ORM:
foreach (parent::getMessages() as $message){ switch ($message->getType()) { case "InvalidCreateAttempt": $messages[]="The record cannot be created because it already
˓→exists"; break;
case "InvalidUpdateAttempt": $messages[]="The record cannot be updated because it doesn't
˓→exist"; break;
case "PresenceOf": $messages[]="The field". $message->getField()." is mandatory
Another type of events are available when the data validation process finds any inconsistency: Operation Name Explanation Insert or Update notSaved Triggered when the INSERT or UPDATE operation fails for any reason Insert, Delete or onValidation- Triggered when any data manipulation operation fails Update Fails
Working with Models (Advanced)
Hydration Modes
As mentioned previously, resultsets are collections of complete objects, this means that every returned result is an object representing a row in the database. These objects can be modified and saved again to persistence:
$robots= Robots::find();
// Manipulating a resultset of complete objects foreach ($robots as $robot){ $robot->year= 2000;
$robot->save(); }
Sometimes records are obtained only to be presented to a user in read-only mode, in these cases it may be useful to change the way in which records are represented to facilitate their handling. The strategy used to represent objects returned in a resultset is called ‘hydration mode’:
$robots= Robots::find();
// Return every robot as an array $robots->setHydrateMode( Resultset::HYDRATE_ARRAYS ); foreach ($robots as $robot){ echo $robot["year"], PHP_EOL; }
// Return every robot as a stdClass $robots->setHydrateMode(
Resultset::HYDRATE_OBJECTS ); foreach ($robots as $robot){ echo $robot->year, PHP_EOL; }
// Return every robot as a Robots instance $robots->setHydrateMode( Resultset::HYDRATE_RECORDS ); foreach ($robots as $robot){ echo $robot->year, PHP_EOL; }
Hydration mode can also be passed as a parameter of ‘find’:
Some models may have identity columns. These columns usually are the primary key of the mapped table. Phal- con\Mvc\Model can recognize the identity column omitting it in the generated SQL INSERT, so the database system can generate an auto-generated value for it. Always after creating a record, the identity field will be registered with the value generated in the database system for it:
$robot->save(); echo "The generated id is:", $robot->id;
Phalcon\Mvc\Model is able to recognize the identity column. Depending on the database system, those columns may be serial columns like in PostgreSQL or auto_increment columns in the case of MySQL. PostgreSQL uses sequences to generate auto-numeric values, by default, Phalcon tries to obtain the generated value from the sequence “table_field_seq”, for example: robots_id_seq, if that sequence has a different name, the getSequenceName() method needs to be implemented:
use Phalcon\Mvc\Model; class Robots extends Model { public function getSequenceName() { return "robots_sequence_name"; } }
Skipping Columns
To tell Phalcon\Mvc\Model that always omits some fields in the creation and/or update of records in order to delegate the database system the assignation of the values by a trigger or a default:
skipAttributes( [ "year", "price", ] );
// Skips only when inserting $this->skipAttributesOnCreate( [ "created_at", ] );
// Skips only when updating $this->skipAttributesOnUpdate( [ "modified_in", ] ); } }
This will ignore globally these fields on each INSERT/UPDATE operation on the whole application. If you want to ignore different attributes on different INSERT/UPDATE operations, you can specify the second parameter (boolean) - true for replacement. Forcing a default value can be done in the following way:
$robot->name="Bender"; $robot->year= 1999; $robot->created_at= new RawValue("default");
$robot->create();
A callback also can be used to create a conditional assignment of automatic default values:
price> 10000){ $this->type= new RawValue("default"); } } }
Never use a Phalcon\Db\RawValue to assign external data (such as user input) or variable data. The value of these fields is ignored when binding parameters to the query. So it could be used to attack the application injecting SQL.
Dynamic Update
SQL UPDATE statements are by default created with every column defined in the model (full all-field SQL update). You can change specific models to make dynamic updates, in this case, just the fields that had changed are used to create the final SQL statement. In some cases this could improve the performance by reducing the traffic between the application and the database server, this specially helps when the table has blob/text fields:
The ORM supports an independent column map, which allows the developer to use different column names in the model to the ones in the table. Phalcon will recognize the new column names and will rename them accordingly to match the respective columns in the database. This is a great feature when one needs to rename fields in the database without having to worry about all the queries in the code. A change in the column map in the model will take care of the rest. For example:
public $theName;
public $theType;
public $theYear;
public function columnMap() { // Keys are the real names in the table and // the values their names in the application return [ "id" =>"code", "the_name" =>"theName", "the_type" =>"theType", "the_year" =>"theYear", ]; } }
Then you can use the new names naturally in your code:
// Find a robot by its name $robot= Robots::findFirst( "theName = 'Voltron'" ); echo $robot->theName," \n";
// Get robots ordered by type $robot= Robots::find( [ "order" =>"theType DESC",
Take into consideration the following the next when renaming your columns: • References to attributes in relationships/validators must use the new names • Refer the real column names will result in an exception by the ORM The independent column map allow you to: • Write applications using your own conventions • Eliminate vendor prefixes/suffixes in your code • Change column names without change your application code
Record Snapshots
Specific models could be set to maintain a record snapshot when they’re queried. You can use this feature to implement auditing or just to know what fields are changed according to the data queried from the persistence:
keepSnapshots(true); } }
When activating this feature the application consumes a bit more of memory to keep track of the original values obtained from the persistence. In models that have this feature activated you can check what fields changed:
// Get a record from the database $robot= Robots::findFirst();
If a model is mapped to a table that is in a different schemas/databases than the default. You can use the setSchema() method to define that:
setSchema("toys"); } }
Setting multiple databases
In Phalcon, all models can belong to the same database connection or have an individual one. Actually, when Phal- con\Mvc\Model needs to connect to the database it requests the “db” service in the application’s services container. You can overwrite this service setting it in the initialize() method:
// This service returns a MySQL database $di->set( "dbMysql", function () { return new MysqlPdo( [ "host" =>"localhost", "username" =>"root", "password" =>"secret", "dbname" =>"invo", ] ); } );
// This service returns a PostgreSQL database $di->set( "dbPostgres", function () { return new PostgreSQLPdo( [ "host" =>"localhost", "username" =>"postgres", "password" =>"", "dbname" =>"invo", ] ); } );
Then, in the initialize() method, we define the connection service for the model:
setConnectionService("dbPostgres"); } }
But Phalcon offers you more flexibility, you can define the connection that must be used to ‘read’ and for ‘write’. This is specially useful to balance the load to your databases implementing a master-slave architecture:
setReadConnectionService("dbSlave");
$this->setWriteConnectionService("dbMaster"); } }
The ORM also provides Horizontal Sharding facilities, by allowing you to implement a ‘shard’ selection according to the current query conditions:
class Robots extends Model { /** * Dynamically selects a shard * * @param array $intermediate * @param array $bindParams * @param array $bindTypes */ public function selectReadConnection($intermediate, $bindParams, $bindTypes) { // Check if there is a 'where' clause in the select if (isset($intermediate["where"])) { $conditions= $intermediate["where"];
// Choose the possible shard according to the conditions if ($conditions["left"]["name"] ==="id"){ $id= $conditions["right"]["value"];
if ($id>0&& $id< 10000){ return $this->getDI()->get("dbShard1"); }
if ($id> 10000){ return $this->getDI()->get("dbShard2"); } } }
// Use a default shard return $this->getDI()->get("dbShard0"); } }
The selectReadConnection() method is called to choose the right connection, this method intercepts any new query executed:
$robot= Robots::findFirst('id = 101');
Injecting services into Models
You may be required to access the application services within a model, the following example explains how to do that:
public function notSaved() { // Obtain the flash service from the DI container $flash= $this->getDI()->getFlash();
$messages= $this->getMessages();
// Show validation messages foreach ($messages as $message){ $flash->error($message); } } }
The “notSaved” event is triggered every time that a “create” or “update” action fails. So we’re flashing the validation messages obtaining the “flash” service from the DI container. By doing this, we don’t have to print messages after each save.
Disabling/Enabling Features
In the ORM we have implemented a mechanism that allow you to enable/disable specific features or options globally on the fly. According to how you use the ORM you can disable that you aren’t using. These options can also be temporarily disabled if required:
The available options are: Option Description De- fault events Enables/Disables callbacks, hooks and event notifications from all the models true columnRenaming Enables/Disables the column renaming true notNullValida- The ORM automatically validate the not null columns present in the mapped table true tions virtualFor- Enables/Disables the virtual foreign keys true eignKeys phqlLiterals Enables/Disables literals in the PHQL parser true lateStateBinding Enables/Disables late state binding of the Mvc\Model::cloneResultMap() false method
Stand-Alone component
Using Phalcon\Mvc\Model in a stand-alone mode can be demonstrated below:
// Setup a connection $di->set( "db", new Connection( [ "dbname" =>"sample.db", ] ) );
// Set a models manager $di->set( "modelsManager", new ModelsManager() );
// Use the memory meta-data adapter or other $di->set( "modelsMetadata", new MetaData() );
// Create a model class Robots extends Model {
}
// Use the model echo Robots::count();
Phalcon Query Language (PHQL)
Phalcon Query Language, PhalconQL or simply PHQL is a high-level, object-oriented SQL dialect that allows to write queries using a standardized SQL-like language. PHQL is implemented as a parser (written in C) that translates syntax in that of the target RDBMS. To achieve the highest performance possible, Phalcon provides a parser that uses the same technology as SQLite. This technology provides a small in-memory parser with a very low memory footprint that is also thread-safe. The parser first checks the syntax of the pass PHQL statement, then builds an intermediate representation of the statement and finally it converts it to the respective SQL dialect of the target RDBMS. In PHQL, we’ve implemented a set of features to make your access to databases more secure: • Bound parameters are part of the PHQL language helping you to secure your code • PHQL only allows one SQL statement to be executed per call preventing injections
• PHQL ignores all SQL comments which are often used in SQL injections • PHQL only allows data manipulation statements, avoiding altering or dropping tables/databases by mistake or externally without authorization • PHQL implements a high-level abstraction allowing you to handle tables as models and fields as class attributes
Usage Example
To better explain how PHQL works consider the following example. We have two models “Cars” and “Brands”:
use Phalcon\Mvc\Model;
class Cars extends Model { public $id;
public $name;
public $brand_id;
public $price;
public $year;
public $style;
/** * This model is mapped to the table sample_cars */ public function getSource() { return "sample_cars"; }
/** * A car only has a Brand, but a Brand have many Cars */ public function initialize() { $this->belongsTo("brand_id","Brands","id"); } }
And every Car has a Brand, so a Brand has many Cars:
/** * The model Brands is mapped to the "sample_brands" table */ public function getSource() { return "sample_brands"; }
/** * A Brand can have many Cars */ public function initialize() { $this->hasMany("id","Cars","brand_id"); } }
Creating PHQL Queries
PHQL queries can be created just by instantiating the class Phalcon\Mvc\Model\Query:
// Instantiate the Query $query= new Query( "SELECT * FROM Cars", $this->getDI() );
// Execute the query returning a result if any $cars= $query->execute();
From a controller or a view, it’s easy to create/execute them using an injected models manager:
// Executing a simple query $query= $this->modelsManager->createQuery("SELECT * FROM Cars"); $cars= $query->execute();
// With bound parameters $query= $this->modelsManager->createQuery("SELECT * FROM Cars WHERE name = :name:"); $cars= $query->execute( [ "name" =>"Audi", ] );
Or simply execute it:
// Executing a simple query $cars= $this->modelsManager->executeQuery(
// Executing with bound parameters $cars= $this->modelsManager->executeQuery( "SELECT * FROM Cars WHERE name = :name:", [ "name" =>"Audi", ] );
Selecting Records
As the familiar SQL, PHQL allows querying of records using the SELECT statement we know, except that instead of specifying tables, we use the models classes:
$query= $manager->createQuery( "SELECT * FROM Cars ORDER BY Cars.name" );
$query= $manager->createQuery( "SELECT Cars.name FROM Cars ORDER BY Cars.name" );
Classes in namespaces are also allowed:
$phql="SELECT * FROM Formula\Cars ORDER BY Formula\Cars.name"; $query= $manager->createQuery($phql);
$phql="SELECT Formula\Cars.name FROM Formula\Cars ORDER BY Formula\Cars.name"; $query= $manager->createQuery($phql);
$phql="SELECT c.name FROM Formula\Cars c ORDER BY c.name"; $query= $manager->createQuery($phql);
Most of the SQL standard is supported by PHQL, even nonstandard directives such as LIMIT:
$phql="SELECT c.name FROM Cars AS c WHERE c.brand_id = 21 ORDER BY c.name LIMIT 100
˓→";
$query= $manager->createQuery($phql);
Result Types
Depending on the type of columns we query, the result type will vary. If you retrieve a single whole object, then the object returned is a Phalcon\Mvc\Model\Resultset\Simple. This kind of resultset is a set of complete model objects:
Complete objects can be modified and re-saved in the database because they represent a complete record of the asso- ciated table. There are other types of queries that do not return complete objects, for example:
$phql="SELECT c.id, c.name FROM Cars AS c ORDER BY c.name";
We are only requesting some fields in the table, therefore those cannot be considered an entire object, so the returned object is still a resultset of type Phalcon\Mvc\Model\Resultset\Simple. However, each element is a standard object that only contain the two columns that were requested. These values that don’t represent complete objects are what we call scalars. PHQL allows you to query all types of scalars: fields, functions, literals, expressions, etc..:
$phql="SELECT CONCAT(c.id, ' ', c.name) AS id_name FROM Cars AS c ORDER BY c.name";
$cars= $manager->executeQuery($phql); foreach ($cars as $car){ echo $car->id_name," \n"; }
As we can query complete objects or scalars, we can also query both at once:
Scalars are mapped as properties of each “row”, while complete objects are mapped as properties with the name of its related model.
Joins
It’s easy to request records from multiple models using PHQL. Most kinds of Joins are supported. As we defined relationships in the models, PHQL adds these conditions automatically:
$phql="SELECT Cars.name AS car_name, Brands.name AS brand_name FROM Cars JOIN Brands
SELECT `artists`.`name`,`songs`.`name` FROM `artists` INNER JOIN `albums` ON `albums`.`artists_id`=`artists`.`id` INNER JOIN `songs` ON `albums`.`songs_id`=`songs`.`id` WHERE `artists`.`genre`= 'Trip-Hop'
Aggregations
The following examples show how to use aggregations in PHQL:
// How much are the prices of all the cars? $phql="SELECT SUM(price) AS summatory FROM Cars"; $row= $manager->executeQuery($phql)->getFirst();
// How many cars are by each brand? $phql="SELECT Cars.brand_id, COUNT( *) FROM Cars GROUP BY Cars.brand_id"; $rows= $manager->executeQuery($phql); foreach ($rows as $row){ echo $row->brand_id,'', $row["1"]," \n"; }
// How many cars are by each brand? $phql="SELECT Brands.name, COUNT( *) FROM Cars JOIN Brands GROUP BY 1"; $rows= $manager->executeQuery($phql); foreach ($rows as $row){ echo $row->name,'', $row["1"]," \n"; }
$phql="SELECT MAX(price) AS maximum, MIN(price) AS minimum FROM Cars"; $rows= $manager->executeQuery($phql); foreach ($rows as $row){ echo $row["maximum"],'', $row["minimum"]," \n"; }
// Count distinct used brands $phql="SELECT COUNT(DISTINCT brand_id) AS brandId FROM Cars"; $rows= $manager->executeQuery($phql); foreach ($rows as $row){ echo $row->brandId," \n"; }
Conditions
Conditions allow us to filter the set of records we want to query. The WHERE clause allows to do that:
// Simple conditions $phql="SELECT * FROM Cars WHERE Cars.name = 'Lamborghini Espada'"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE Cars.price > 10000"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE TRIM(Cars.name) = 'Audi R8'"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE Cars.name LIKE 'Ferrari%'"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE Cars.name NOT LIKE 'Ferrari%'"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE Cars.price IS NULL"; $cars= $manager->executeQuery($phql);
$phql="SELECT * FROM Cars WHERE Cars.id IN (120, 121, 122)"; $cars= $manager->executeQuery($phql);
Phalcon doesn’t only transform the PHQL statements into SQL. All events and business rules defined in the model are executed as if we created individual objects manually. Let’s add a business rule on the model cars. A car cannot cost less than $ 10,000:
price< 10000){ $this->appendMessage( new Message("A car cannot cost less than$ 10,000") );
return false; } } }
If we made the following INSERT in the models Cars, the operation will not be successful because the price does not meet the business rule that we implemented. By checking the status of the insertion we can print any validation messages generated internally:
$result= $manager->executeQuery($phql); if ($result->success() === false){ foreach ($result->getMessages() as $message){ echo $message->getMessage(); } }
Updating Data
Updating rows is very similar than inserting rows. As you may know, the instruction to update records is UPDATE. When a record is updated the events related to the update operation will be executed for each row.
// Updating a single column $phql="UPDATE Cars SET price = 15000.00 WHERE id = 101"; $manager->executeQuery($phql);
// Updating multiples columns $phql="UPDATE Cars SET price = 15000.00, type = 'Sedan' WHERE id = 101"; $manager->executeQuery($phql);
// Updating multiples rows $phql="UPDATE Cars SET price = 7000.00, type = 'Sedan' WHERE brands_id > 5"; $manager->executeQuery($phql);
// Using placeholders $phql="UPDATE Cars SET price = ?0, type = ?1 WHERE brands_id > ?2"; $manager->executeQuery( $phql, [ 0 => 7000.00, 1 => 'Sedan', 2 =>5, ] );
An UPDATE statement performs the update in two phases: • First, if the UPDATE has a WHERE clause it retrieves all the objects that match these criteria, • Second, based on the queried objects it updates/changes the requested attributes storing them to the relational database This way of operation allows that events, virtual foreign keys and validations take part of the updating process. In summary, the following code:
$phql="UPDATE Cars SET price = 15000.00 WHERE id > 101";
$result= $manager->executeQuery($phql); if ($result->success() === false){ $messages= $result->getMessages();
foreach ($messages as $message){ echo $message->getMessage(); } } is somewhat equivalent to:
$messages= null;
$process= function () use (&$messages){ $cars= Cars::find("id > 101");
foreach ($cars as $car){ $car->price= 15000;
if ($car->save() === false){ $messages= $car->getMessages();
When a record is deleted the events related to the delete operation will be executed for each row:
// Deleting a single row $phql="DELETE FROM Cars WHERE id = 101"; $manager->executeQuery($phql);
// Deleting multiple rows $phql="DELETE FROM Cars WHERE id > 100"; $manager->executeQuery($phql);
// Using placeholders $phql="DELETE FROM Cars WHERE id BETWEEN :initial: AND :final:"; $manager->executeQuery( $phql, [ "initial" =>1, "final" => 100, ] );
DELETE operations are also executed in two phases like UPDATEs. To check if the deletion produces any validation messages you should check the status code returned:
// Deleting multiple rows $phql="DELETE FROM Cars WHERE id > 100";
$result= $manager->executeQuery($phql); if ($result->success() === false){ $messages= $result->getMessages();
foreach ($messages as $message){ echo $message->getMessage(); } }
Creating queries using the Query Builder
A builder is available to create PHQL queries without the need to write PHQL statements, also providing IDE facilities:
// Getting a whole set $robots= $this->modelsManager->createBuilder() ->from("Robots") ->join("RobotsParts") ->orderBy("Robots.name") ->getQuery() ->execute();
// 'SELECT Robots.* FROM Robots GROUP BY Robots.name'; $builder->from("Robots") ->groupBy("Robots.name");
// 'SELECT Robots.* FROM Robots GROUP BY Robots.name, Robots.id'; $builder->from("Robots") ->groupBy(["Robots.name","Robots.id"]);
// 'SELECT Robots.name, SUM(Robots.price) FROM Robots GROUP BY Robots.name'; $builder->columns(["Robots.name","SUM(Robots.price)"]) ->from("Robots") ->groupBy("Robots.name");
// 'SELECT Robots.name, SUM(Robots.price) FROM Robots GROUP BY Robots.name HAVING
// 'SELECT Robots.* FROM Robots JOIN RobotsParts'; $builder->from("Robots") ->join("RobotsParts");
// 'SELECT Robots.* FROM Robots JOIN RobotsParts AS p'; $builder->from("Robots") ->join("RobotsParts", null,"p");
// 'SELECT Robots.* FROM Robots JOIN RobotsParts ON Robots.id = RobotsParts.robots_id ˓→AS p'; $builder->from("Robots") ->join("RobotsParts","Robots.id = RobotsParts.robots_id","p");
// 'SELECT Robots.* FROM Robots // JOIN RobotsParts ON Robots.id = RobotsParts.robots_id AS p // JOIN Parts ON Parts.id = RobotsParts.parts_id AS t'; $builder->from("Robots") ->join("RobotsParts","Robots.id = RobotsParts.robots_id","p") ->join("Parts","Parts.id = RobotsParts.parts_id","t");
// 'SELECT r.* FROM Robots AS r'; $builder->addFrom("Robots","r");
// 'SELECT Robots.*, p.* FROM Robots, Parts AS p'; $builder->from("Robots") ->addFrom("Parts","p");
// 'SELECT r.*, p.* FROM Robots AS r, Parts AS p'; $builder->from(["r" =>"Robots"]) ->addFrom("Parts","p");
// 'SELECT r.*, p.* FROM Robots AS r, Parts AS p'; $builder->from(["r" =>"Robots","p" =>"Parts"]);
// 'SELECT Robots.* FROM Robots WHERE id BETWEEN 1 AND 100'; $builder->from("Robots") ->betweenWhere("id",1, 100);
// 'SELECT Robots.* FROM Robots WHERE id IN (1, 2, 3)'; $builder->from("Robots") ->inWhere("id",[1,2,3]);
// 'SELECT Robots.* FROM Robots WHERE id NOT IN (1, 2, 3)'; $builder->from("Robots") ->notInWhere("id",[1,2,3]);
// 'SELECT Robots.* FROM Robots WHERE name LIKE '%Art%'; $builder->from("Robots") ->where("name LIKE :name:",["name" =>"%". $name."%"]);
// 'SELECT r.* FROM Store\Robots WHERE r.name LIKE '%Art%'; $builder->from(['r' => 'Store\Robots']) ->where("r.name LIKE :name:",["name" =>"%". $name."%"]);
Bound Parameters
Bound parameters in the query builder can be set as the query is constructed or past all at once when executing:
// Passing parameters in the query construction $robots= $this->modelsManager->createBuilder() ->from("Robots") ->where("name = :name:",["name" => $name]) ->andWhere("type = :type:",["type" => $type]) ->getQuery() ->execute();
Literals can be disabled in PHQL, this means that directly using strings, numbers and boolean values in PHQL strings will be disallowed. If PHQL statements are created embedding external data on them, this could open the application to potential SQL injections:
$phql="SELECT * FROM Models\Users WHERE login = '$login'";
$result= $manager->executeQuery($phql);
If $login is changed to ' OR '' = ', the produced PHQL is:
SELECT * FROM Models\Users WHERE login = '' OR '' = ''
Which is always true no matter what the login stored in the database is. If literals are disallowed strings can be used as part of a PHQL statement, thus an exception will be thrown forcing the developer to use bound parameters. The same query can be written in a secure way like this:
$phql="SELECT Robots. * FROM Robots WHERE Robots.name = :name:";
Bound parameters can be used even if literals are allowed or not. Disallowing them is just another security decision a developer could take in web applications.
Escaping Reserved Words
PHQL has a few reserved words, if you want to use any of them as attributes or models names, you need to escape those words using the cross-database escaping delimiters ‘[’ and ‘]’:
$phql="SELECT * FROM [Update]"; $result= $manager->executeQuery($phql);
$phql="SELECT id, [Like] FROM Posts"; $result= $manager->executeQuery($phql);
The delimiters are dynamically translated to valid delimiters depending on the database system where the application is currently running on.
PHQL Lifecycle
Being a high-level language, PHQL gives developers the ability to personalize and customize different aspects in order to suit their needs. The following is the life cycle of each PHQL statement executed: • The PHQL is parsed and converted into an Intermediate Representation (IR) which is independent of the SQL implemented by database system • The IR is converted to valid SQL according to the database system associated to the model • PHQL statements are parsed once and cached in memory. Further executions of the same statement result in a slightly faster execution
Using Raw SQL
A database system could offer specific SQL extensions that aren’t supported by PHQL, in this case, a raw SQL can be appropriate:
sql="SELECT * FROM robots WHERE id > 0";
// Base model $robot= new Robots();
// Execute the query return new Resultset( null, $robot, $robot->getReadConnection()->query($sql) ); } }
If Raw SQL queries are common in your application a generic method could be added to your model:
Some things to keep in mind when using PHQL: • Classes are case-sensitive, if a class is not defined with the same name as it was created this could lead to an unexpected behavior in operating systems with case-sensitive file systems such as Linux. • Correct charset must be defined in the connection to bind parameters with success. • Aliased classes aren’t replaced by full namespaced classes since this only occurs in PHP code and not inside strings. • If column renaming is enabled avoid using column aliases with the same name as columns to be renamed, this may confuse the query resolver.
Caching in the ORM
Every application is different, we could have models whose data change frequently and others that rarely change. Accessing database systems is often one of the most common bottlenecks in terms of performance. This is due to the complex connection/communication processes that PHP must do in each request to obtain data from the database. Therefore, if we want to achieve good performance we need to add some layers of caching where the application requires it. This chapter explains the possible points where it is possible to implement caching to improve performance. The framework gives you the tools to implement the cache where you demand of it according to the architecture of your application.
A well established technique to avoid continuously accessing to the database is to cache resultsets that don’t change frequently using a system with faster access (usually memory). When Phalcon\Mvc\Model requires a service to cache resultsets, it will request it to the Dependency Injector Container with the convention name “modelsCache”. As Phalcon provides a component to cache any kind of data, we’ll explain how to integrate it with Models. First, you must register it as a service in the services container:
use Phalcon\Cache\Frontend\Data as FrontendData; use Phalcon\Cache\Backend\Memcache as BackendMemcache;
// Set the models cache service $di->set( "modelsCache", function () { // Cache data for one day by default $frontCache= new FrontendData( [ "lifetime" => 86400, ] );
You have complete control in creating and customizing the cache before being used by registering the service as an anonymous function. Once the cache setup is properly defined you could cache resultsets as follows:
// Get products without caching $products= Products::find();
// Just cache the resultset. The cache will expire in 1 hour (3600 seconds) $products= Products::find( [ "cache" =>[ "key" =>"my-cache", ], ] );
// Cache the resultset for only for 5 minutes $products= Products::find(
// Use the 'cache' service from the DI instead of 'modelsCache' $products= Products::find( [ "cache" =>[ "key" =>"my-cache", "service" =>"cache", ], ] );
Caching could be also applied to resultsets generated using relationships:
// Query some post $post= Post::findFirst();
// Get comments related to a post, also cache it $comments= $post->getComments( [ "cache" =>[ "key" =>"my-key", ], ] );
// Get comments related to a post, setting lifetime $comments= $post->getComments( [ "cache" =>[ "key" =>"my-key", "lifetime" => 3600, ], ] );
When a cached resultset needs to be invalidated, you can simply delete it from the cache using the previously specified key. Note that not all resultsets should be cached. Results that change very frequently should not be cached since they are invalidated very quickly and caching in that case impacts performance. Additionally, large datasets that do not change frequently could be cached, but that is a decision that the developer has to make based on the available caching mechanism and whether the performance impact to simply retrieve that data in the first place is acceptable.
Forcing Cache
Earlier we saw how Phalcon\Mvc\Model integrates with the caching component provided by the framework. To make a record/resultset cacheable we pass the key ‘cache’ in the array of parameters:
// Cache the resultset for only for 5 minutes $products= Products::find( [ "cache" =>[ "key" =>"my-cache", "lifetime" => 300, ], ] );
This gives us the freedom to cache specific queries, however if we want to cache globally every query performed over the model, we can override the find()/:code:`findFirst() method to force every query to be cached:
public static function findFirst($parameters= null) { // ... } }
Accessing the database is several times slower than calculating a cache key. You’re free to implement any key gener- ation strategy you find to better for your needs. Note that a good key avoids collisions as much as possible - meaning that different keys should return unrelated records. This gives you full control on how the cache should be implemented for each model. If this strategy is common to several models you can create a base class for all of them:
public static function find($parameters= null) { // ... Custom caching strategy }
public static function findFirst($parameters= null) { // ... Custom caching strategy } }
Then use this class as base class for each ‘Cacheable’ model:
}
Caching PHQL Queries
Regardless of the syntax we used to create them, all queries in the ORM are handled internally using PHQL. This language gives you much more freedom to create all kinds of queries. Of course these queries can be cached:
Some models may have relationships with other models. This allows us to easily check the records that relate to instances in memory:
// Get some invoice $invoice= Invoices::findFirst();
// Get the customer related to the invoice $customer= $invoice->customer;
// Print his/her name echo $customer->name," \n";
This example is very simple, a customer is queried and can be used as required, for example, to show its name. This also applies if we retrieve a set of invoices to show customers that correspond to these invoices:
// Get a set of invoices // SELECT * FROM invoices; $invoices= Invoices::find(); foreach ($invoices as $invoice){ // Get the customer related to the invoice // SELECT * FROM customers WHERE id = ?; $customer= $invoice->customer;
// Print his/her name echo $customer->name," \n"; }
A customer may have one or more bills so, in this example, the same customer record may be unnecessarily queried several times. To avoid this, we could mark the relationship as reusable; by doing so, we tell the ORM to automatically reuse the records from memory instead of re-querying them again and again:
{ public function initialize() { $this->belongsTo( "customers_id", "Customer", "id", [ "reusable" => true, ] ); } }
Note that this type of cache works in memory only, this means that cached data are released when the request is terminated.
Caching Related Records
When a related record is queried, the ORM internally builds the appropriate condition and gets the required records using find()/findFirst() in the target model according to the following table: Type Description Implicit Method Belongs-To Returns a model instance of the related record directly findFirst() Has-One Returns a model instance of the related record directly findFirst() Has-Many Returns a collection of model instances of the referenced model find() This means that when you get a related record you could intercept how the data is obtained by implementing the corresponding method:
// Get some invoice $invoice= Invoices::findFirst();
// Get the customer related to the invoice $customer= $invoice->customer; // Invoices::findFirst("...");
// Same as above $customer= $invoice->getCustomer(); // Invoices::findFirst("...");
Accordingly, we could replace the findFirst() method in the Invoices model and implement the cache we consider most appropriate:
In this scenario, we assume that every time we query a result we also retrieve their associated records. If we store the records found together with their related entities perhaps we could reduce a bit the overhead required to obtain all entities:
protected static function _getCache($key) { // Returns data from a cache }
protected static function _setCache($key, $results) { // Stores data in the cache }
public static function find($parameters= null) { // Create a unique key $key= self::_createKey($parameters);
// Check if there are data in the cache $results= self::_getCache($key);
// Valid data is an object if (is_object($results)) { return $results; }
$results= [];
$invoices= parent::find($parameters);
foreach ($invoices as $invoice){ // Query the related customer $customer= $invoice->customer;
// Assign it to the record $invoice->customer= $customer;
$results[]= $invoice; }
// Store the invoices in the cache + their customers self::_setCache($key, $results);
public function initialize() { // Add relations and initialize other stuff } }
Getting the invoices from the cache already obtains the customer data in just one hit, reducing the overall overhead of the operation. Note that this process can also be performed with PHQL following an alternative solution:
use Phalcon\Mvc\Model;
class Invoices extends Model { public function initialize() { // Add relations and initialize other stuff }
protected static function _createKey($conditions, $params) { // ... Create a cache key based on the parameters }
public function getInvoicesCustomers($conditions, $params= null) { $phql="SELECT Invoices. *, Customers.* FROM Invoices JOIN Customers WHERE". ˓→ $conditions;
In this scenario, the cache is implemented differently depending on the conditions received. We might decide that the cache backend should be determined by the primary key: Type Cache Backend 1 - 10000 mongo1 10000 - 20000 mongo2 > 20000 mongo3 The easiest way is adding a static method to the model that chooses the right cache to be used:
return self::find( [ "id >=". $initial." AND id <=". $final, "cache" =>[ "service" => $service, ], ] ); } }
This approach solves the problem, however, if we want to add other parameters such orders or conditions we would have to create a more complicated method. Additionally, this method does not work if the data is obtained using related records or a find()/findFirst():
$robots= Robots::find("id < 1000"); $robots= Robots::find("id > 100 AND type = 'A'"); $robots= Robots::find("(id > 100 AND type = 'A') AND id < 2000");
$robots= Robots::find( [ "(id > ?0 AND type = 'A') AND id < ?1", "bind" =>[100, 2000], "order" =>"type", ] );
To achieve this we need to intercept the intermediate representation (IR) generated by the PHQL parser and thus customize the cache everything possible: The first is create a custom builder, so we can generate a totally customized query:
Instead of directly returning a Phalcon\Mvc\Model\Query, our custom builder returns a CustomQuery instance, this class looks like:
parse();
// Check if the query has conditions if (isset($ir["where"])) { // The fields in the conditions can have any order // We need to recursively check the conditions tree // to find the info we're looking for $visitor= new CustomNodeVisitor();
// Recursively visits the nodes $visitor->visit($ir["where"]);
// Execute the query $result= $this->_executeSelect($ir, $params, $types);
// Cache the result // ...
return $result; } }
Implementing a helper (CustomNodeVisitor) that recursively checks the conditions looking for fields that tell us the possible range to be used in the cache:
As well as most moderns database systems PHQL internally caches the execution plan, if the same statement is executed several times PHQL reuses the previously generated plan improving performance, for a developer to take better advantage of this is highly recommended build all your SQL statements passing variable parameters as bound parameters:
In the above example, ten plans were generated increasing the memory usage and processing in the application. Rewriting the code to take advantage of bound parameters reduces the processing by both ORM and database system:
$phql="SELECT * FROM Store\Robots WHERE id = ?0"; for ($i=1; $i <= 10; $i++){ $robots= $this->modelsManager->executeQuery( $phql, [ $i, ] );
// ... }
Performance can be also improved reusing the PHQL query:
Execution plans for queries involving prepared statements are also cached by most database systems reducing the overall execution time, also protecting your application against SQL Injections.
ODM (Object-Document Mapper)
In addition to its ability to map tables in relational databases, Phalcon can map documents from NoSQL databases. The ODM offers a CRUD functionality, events, validations among other services. Due to the absence of SQL queries and planners, NoSQL databases can see real improvements in performance using the Phalcon approach. Additionally, there are no SQL building reducing the possibility of SQL injections. The following NoSQL databases are supported: Name Description MongoDB MongoDB is a scalable, high-performance, open source NoSQL database.
Creating Models
A model is a class that extends from Phalcon\Mvc\Collection. It must be placed in the models directory. A model file must contain a single class; its class name should be in camel case notation:
If you’re using PHP 5.4/5.5 is recommended declare each column that makes part of the model in order to save memory and reduce the memory allocation. By default model “Robots” will refer to the collection “robots”. If you want to manually specify another name for the mapping collection, you can use the setSource() method:
setSource("the_robots"); } }
Understanding Documents To Objects
Every instance of a model represents a document in the collection. You can easily access collection data by reading object properties. For example, for a collection “robots” with the documents:
Namespaces can be used to avoid class name collision. In this case it is necessary to indicate the name of the related collection using the setSource() method:
As Phalcon\Mvc\Collection relies on the Mongo PHP extension you have the same facilities to query documents and convert them transparently to model instances:
// How many robots are there? $robots= Robots::find(); echo "There are", count($robots)," \n";
// How many mechanical robots are there? $robots= Robots::find( [ [ "type" =>"mechanical", ] ] ); echo "There are", count($robots)," \n";
// Get and print mechanical robots ordered by name upward $robots= Robots::find( [ [ "type" =>"mechanical", ], "sort" =>[ "name" =>1, ], ] ); foreach ($robots as $robot){ echo $robot->name," \n"; }
// Get first 100 mechanical robots ordered by name $robots= Robots::find( [ [ "type" =>"mechanical", ], "sort" =>[ "name" =>1, ], "limit" => 100, ]
); foreach ($robots as $robot){ echo $robot->name," \n"; }
You could also use the findFirst() method to get only the first record matching the given criteria:
// What's the first robot in robots collection? $robot= Robots::findFirst(); echo "The robot name is", $robot->name," \n";
// What's the first mechanical robot in robots collection? $robot= Robots::findFirst( [ [ "type" =>"mechanical", ] ] ); echo "The first mechanical robot name is", $robot->name," \n";
Both find() and findFirst() methods accept an associative array specifying the search criteria:
// First robot where type = "mechanical" and year = "1999" $robot= Robots::findFirst( [ "conditions" =>[ "type" =>"mechanical", "year" =>"1999", ], ] );
// All virtual robots ordered by name downward $robots= Robots::find( [ "conditions" =>[ "type" =>"virtual", ], "sort" =>[ "name" =>-1, ], ] );
Pa- Description Example rame- ter conditionsSearch conditions for the find operation. Is used to extract only those "conditions" => records that fulfill a specified criterion. By default Phalcon_model array('$gt' => assumes the first parameter are the conditions. 1990) fields Returns specific columns instead of the full fields in the collection. "fields" => When using this option an incomplete object is returned array('name' => true) sort It’s used to sort the resultset. Use one or more fields as each element in "sort" => the array, 1 means ordering upwards, -1 downward array("name" => -1, "status" => 1) limit Limit the results of the query to results to certain range "limit" => 10 skip Skips a number of results "skip" => 50 If you have experience with SQL databases, you may want to check the SQL to Mongo Mapping Chart.
Aggregations
A model can return calculations using aggregation framework provided by Mongo. The aggregated values are calculate without having to use MapReduce. With this option is easy perform tasks such as totaling or averaging field values:
The Phalcon\Mvc\Collection::save() method allows you to create/update documents according to whether they already exist in the collection associated with a model. The save() method is called internally by the create and update methods of Phalcon\Mvc\Collection. Also the method executes associated validators and events that are defined in the model:
$robot->type="mechanical"; $robot->name="Astro Boy"; $robot->year= 1952; if ($robot->save() === false){ echo "Umh, We can't store robots right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "Great, a new robot was saved successfully!"; }
The “_id” property is automatically updated with the MongoId object created by the driver:
$robot->save(); echo "The generated id is:", $robot->getId();
Validation Messages
Phalcon\Mvc\Collection has a messaging subsystem that provides a flexible way to output or store the validation messages generated during the insert/update processes. Each message consists of an instance of the class Phalcon\Mvc\Model\Message. The set of messages generated can be retrieved with the method getMessages(). Each message provides extended information like the field name that generated the message or the message type:
Models allow you to implement events that will be thrown when performing an insert or update. They help define business rules for a certain model. The following are the events supported by Phalcon\Mvc\Collection and their order of execution:
Opera- Name Can stop Explanation tion operation? Insert- beforeValidationYES Is executed before the validation process and the final ing/Updating insert/update to the database Inserting beforeValidationOnCreateYES Is executed before the validation process only when an insertion operation is being made Updating beforeValidationOnUpdateYES Is executed before the fields are validated for not nulls or foreign keys when an updating operation is being made Insert- onValidationFailsYES Is executed before the validation process only when an ing/Updating (already insertion operation is being made stopped) Inserting afterValidationOnCreateYES Is executed after the validation process when an insertion operation is being made Updating afterValidationOnUpdateYES Is executed after the validation process when an updating operation is being made Insert- afterValidation YES Is executed after the validation process ing/Updating Insert- beforeSave YES Runs before the required operation over the database system ing/Updating Updating beforeUpdate YES Runs before the required operation over the database system only when an updating operation is being made Inserting beforeCreate YES Runs before the required operation over the database system only when an inserting operation is being made Updating afterUpdate NO Runs after the required operation over the database system only when an updating operation is being made Inserting afterCreate NO Runs after the required operation over the database system only when an inserting operation is being made Insert- afterSave NO Runs after the required operation over the database system ing/Updating To make a model to react to an event, we must to implement a method with the same name of the event:
Events can be useful to assign values before performing an operation, for example:
public function beforeUpdate() { // Set the modification date $this->modified_in= date("Y-m-d H:i:s"); } }
Additionally, this component is integrated with Phalcon\Events\Manager, this means we can create listeners that run when an event is triggered.
$eventsManager= new EventsManager();
// Attach an anonymous function as a listener for "model" events $eventsManager->attach( "collection:beforeSave", function (Event $event, $robot){ if ($robot->name ==="Scooby Doo"){ echo "Scooby Doo isn't a robot!";
return false; }
return true; } );
$robot= new Robots();
$robot->setEventsManager($eventsManager);
$robot->name="Scooby Doo"; $robot->year= 1969;
$robot->save();
In the example given above the EventsManager only acted as a bridge between an object and a listener (the anonymous function). If we want all objects created in our application use the same EventsManager, then we need to assign this to the Models Manager:
// Registering the collectionManager service $di->set( "collectionManager", function () { $eventsManager= new EventsManager();
// Attach an anonymous function as a listener for "model" events $eventsManager->attach( "collection:beforeSave", function (Event $event, $model){ if (get_class($model) ==="Robots"){ if ($model->name ==="Scooby Doo"){ echo "Scooby Doo isn't a robot!";
return false; } }
return true; } );
// Setting a default EventsManager $modelsManager= new CollectionManager();
$modelsManager->setEventsManager($eventsManager);
return $modelsManager; }, true );
Implementing a Business Rule
When an insert, update or delete is executed, the model verifies if there are any methods with the names of the events listed in the table above. We recommend that validation methods are declared protected to prevent that business logic implementation from being exposed publicly. The following example implements an event that validates the year cannot be smaller than 0 on update or insert:
use Phalcon\Mvc\Collection;
class Robots extends Collection { public function beforeSave() { if ($this->year<0){ echo "Year cannot be smaller than zero!";
return false; } } }
Some events return false as an indication to stop the current operation. If an event doesn’t return anything, Phal- con\Mvc\Collection will assume a true value.
Phalcon\Mvc\Collection provides several events to validate data and implement business rules. The special “valida- tion” event allows us to call built-in validators over the record. Phalcon exposes a few built-in validators that can be used at this stage of validation. The following example shows how to use it:
$validation->add( "type", new InclusionIn( [ "message" =>"Type must be: mechanical or virtual", "domain" =>[ "Mechanical", "Virtual", ], ] ) );
$validation->add( "price", new Numericality( [ "message" =>"Price must be numeric" ] ) );
return $this->validate($validation); } }
The example given above performs a validation using the built-in validator “InclusionIn”. It checks the value of the field “type” in a domain list. If the value is not included in the method, then the validator will fail and return false. For more information on validators, see the Validation documentation.
Deleting Records
The Phalcon\Mvc\Collection::delete() method allows you to delete a document. You can use it as fol- lows:
$robot= Robots::findFirst(); if ($robot !== false){ if ($robot->delete() === false){ echo "Sorry, we can't delete the robot right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "The robot was deleted successfully!"; } }
You can also delete many documents by traversing a resultset with a foreach loop:
$robots= Robots::find( [ [ "type" =>"mechanical", ] ] ); foreach ($robots as $robot){ if ($robot->delete() === false){ echo "Sorry, we can't delete the robot right now: \n";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message," \n"; } } else { echo "The robot was deleted successfully!"; } }
The following events are available to define custom business rules that can be executed when a delete operation is performed: Operation Name Can stop operation? Explanation Deleting beforeDelete YES Runs before the delete operation is made Deleting afterDelete NO Runs after the delete operation was made
Validation Failed Events
Another type of events is available when the data validation process finds any inconsistency:
Operation Name Explanation Insert or Update notSave Triggered when the insert/update operation fails for any reason Insert, Delete or onValidationFails Triggered when any data manipulation operation fails Update
Implicit Ids vs. User Primary Keys
By default Phalcon\Mvc\Collection assumes that the _id attribute is automatically generated using MongoIds. If a model uses custom primary keys this behavior can be overridden:
use Phalcon\Mvc\Collection;
class Robots extends Collection { public function initialize() { $this->useImplicitObjectIds(false); } }
Setting multiple databases
In Phalcon, all models can belong to the same database connection or have an individual one. Actually, when Phal- con\Mvc\Collection needs to connect to the database it requests the “mongo” service in the application’s services container. You can overwrite this service setting it in the initialize method:
// This service returns a mongo database at 192.168.1.100 $di->set( "mongo1", function () { $mongo= new MongoClient( "mongodb://scott:[email protected]" );
return $mongo->selectDB("management"); }, true );
// This service returns a mongo database at localhost $di->set( "mongo2", function () { $mongo= new MongoClient( "mongodb://localhost" );
Then, in the initialize() method, we define the connection service for the model:
setConnectionService("mongo1"); } }
Injecting services into Models
You may be required to access the application services within a model, the following example explains how to do that:
getDI()->getShared("flash");
$messages= $this->getMessages();
// Show validation messages foreach ($messages as $message){ $flash->error( (string) $message ); } } }
The “notSave” event is triggered whenever a “creating” or “updating” action fails. We’re flashing the validation messages obtaining the “flash” service from the DI container. By doing this, we don’t have to print messages after each saving.
Using Views
Views represent the user interface of your application. Views are often HTML files with embedded PHP code that perform tasks related solely to the presentation of the data. Views handle the job of providing data to the web browser or other tool that is used to make requests from your application. Phalcon\Mvc\View and Phalcon\Mvc\View\Simple are responsible for the managing the view layer of your MVC ap- plication.
Phalcon automatically passes the execution to the view component as soon as a particular controller has completed its cycle. The view component will look in the views folder for a folder named as the same name of the last con- troller executed and then for a file named as the last action executed. For instance, if a request is made to the URL http://127.0.0.1/blog/posts/show/301, Phalcon will parse the URL as follows: Server Address 127.0.0.1 Phalcon Directory blog Controller posts Action show Parameter 301 The dispatcher will look for a “PostsController” and its action “showAction”. A simple controller file for this example:
}
public function showAction($postId) { // Pass the $postId parameter to the view $this->view->postId= $postId; } }
The setVar() method allows us to create view variables on demand so that they can be used in the view template. The example above demonstrates how to pass the $postId parameter to the respective view template.
Hierarchical Rendering
Phalcon\Mvc\View supports a hierarchy of files and is the default component for view rendering in Phalcon. This hierarchy allows for common layout points (commonly used views), as well as controller named folders defining respective view templates. This component uses by default PHP itself as the template engine, therefore views should have the .phtml extension. If the views directory is app/views then view component will find automatically for these 3 view files. Name File Description Action app/views/posts/show.phtmlThis is the view related to the action. It only will be shown when the “show” action View was executed. Con- app/views/layouts/posts.phtmlThis is the view related to the controller. It only will be shown for every action troller executed within the controller “posts”. All the code implemented in the layout will Layout be reused for all the actions in this controller. Main app/views/index.phtmlThis is main action it will be shown for every controller or action executed within Layout the application. You are not required to implement all of the files mentioned above. Phalcon\Mvc\View will simply move to the next view level in the hierarchy of files. If all three view files are implemented, they will be processed as follows:
Note the lines where the method $this->getContent() was called. This method instructs Phalcon\Mvc\View on where to inject the contents of the previous view executed in the hierarchy. For the example above, the output will be: The generated HTML by the request will be:
Templates are views that can be used to share common view code. They act as controller layouts, so you need to place them in the layouts directory. Templates can be rendered before the layout (using $this->view->setTemplateBefore()) or they can be rendered after the layout (using this->view->setTemplateAfter()). In the following example the template (layouts/common.phtml) is rendered after the main layout (layouts/posts.phtml):
view->setTemplateAfter("common"); }
public function lastAction() { $this->flash->notice( "These are the latest posts" ); } }
As seen above, Phalcon\Mvc\View supports a view hierarchy. You might need to control the level of rendering pro- duced by the view component. The method Phalcon\Mvc\View::setRenderLevel() offers this functional- ity. This method can be invoked from the controller or from a superior view layer to interfere with the rendering process.
}
public function findAction() { // This is an Ajax response so it doesn't generate any kind of view $this->view->setRenderLevel( View::LEVEL_NO_RENDER );
// ... }
public function showAction($postId) { // Shows only the view related to the action $this->view->setRenderLevel( View::LEVEL_ACTION_VIEW ); } }
Class Constant Description Or- der LEVEL_NO_RENDER Indicates to avoid generating any kind of presentation. LEVEL_ACTION_VIEW Generates the presentation to the view associated to the action. 1 LEVEL_BEFORE_TEMPLATE Generates presentation templates prior to the controller layout. 2 LEVEL_LAYOUT Generates the presentation to the controller layout. 3 LEVEL_AFTER_TEMPLATE Generates the presentation to the templates after the controller 4 layout. LEVEL_MAIN_LAYOUT Generates the presentation to the main layout. File 5 views/index.phtml
Disabling render levels
You can permanently or temporarily disable render levels. A level could be permanently disabled if it isn’t used at all in the whole application:
use Phalcon\Mvc\View;
$di->set( "view", function () { $view= new View();
As mentioned above, when Phalcon\Mvc\View is managed by Phalcon\Mvc\Application the view rendered is the one related with the last controller and action executed. You could override this by using the Phalcon\Mvc\View::pick() method:
view->pick("products/search");
// Pick "views-dir/books/list" as view to render $this->view->pick( [ "books", ] );
// Pick "views-dir/products/search" as view to render $this->view->pick( [ 1 =>"search", ] ); } }
Disabling the view
If your controller doesn’t produce any output in the view (or not even have one) you may disable the view component avoiding unnecessary processing:
Alternatively, you can return false to produce the same effect:
use Phalcon\Mvc\Controller;
class UsersController extends Controller { public function closeSessionAction() { // ...
// Disable the view to avoid rendering return false; } }
You can return a ‘response’ object to avoid disable the view manually:
use Phalcon\Mvc\Controller;
class UsersController extends Controller { public function closeSessionAction() { // Close session // ...
// A HTTP Redirect return $this->response->redirect("index/index"); } }
Simple Rendering
Phalcon\Mvc\View\Simple is an alternative component to Phalcon\Mvc\View. It keeps most of the philosophy of Phalcon\Mvc\View but lacks of a hierarchy of files which is, in fact, the main feature of its counterpart. This component allows the developer to have control of when a view is rendered and its location. In addition, this component can leverage of view inheritance available in template engines such as Volt and others. The default component must be replaced in the service container:
use Phalcon\Mvc\View\Simple as SimpleView;
$di->set( "view", function () { $view= new SimpleView();
This is different to Phalcon\Mvc\View who’s render() method uses controllers and actions as parameters:
$params=[ "posts" => Posts::find(), ];
// Phalcon\Mvc\View $view= new \Phalcon\Mvc\View(); echo $view->render("posts","show", $params);
// Phalcon\Mvc\View\Simple $simpleView= new \Phalcon\Mvc\View\Simple(); echo $simpleView->render("posts/show", $params);
Using Partials
Partial templates are another way of breaking the rendering process into simpler more manageable chunks that can be reused by different parts of the application. With a partial, you can move the code for rendering a particular piece of a response to its own file. One way to use partials is to treat them as the equivalent of subroutines: as a way to move details out of a view so that your code can be more easily understood. For example, you might have a view that looks like this:
partial("shared/ad_banner"); ?>
Robots
Check out our specials for robots:
...
The partial() method does accept a second parameter as an array of variables/parameters that only will exists in the scope of the partial:
Phalcon\Mvc\View is available in each controller using the view variable ($this->view). You can use that object to set variables directly to the view from a controller action by using the setVar() method.
public function showAction() { $user= Users::findFirst(); $posts= $user->getPosts();
// Pass all the username and the posts to the views $this->view->setVar("username", $user->username); $this->view->setVar("posts", $posts;
// Using the magic setter $this->view->username= $user->username; $this->view->posts= $posts;
// Passing more than one variable at the same time $this->view->setVars( [ "username" => $user->username, "posts" => $posts, ] ); } }
A variable with the name of the first parameter of setVar() will be created in the view, ready to be used. The variable can be of any type, from a simple string, integer etc. variable to a more complex structure such as array, collection etc.
{{ username }}'s Posts
foreach ($posts as $post){ echo "
", $post->title,"
"; }
?>
Caching View Fragments
Sometimes when you develop dynamic websites and some areas of them are not updated very often, the output is exactly the same between requests. Phalcon\Mvc\View offers caching a part or the whole rendered output to increase performance. Phalcon\Mvc\View integrates with Phalcon\Cache to provide an easier way to cache output fragments. You could manually set the cache handler or set a global handler:
public function showArticleAction() { // Cache this view for 1 hour $this->view->cache( [ "lifetime" => 3600, ] ); }
public function resumeAction() { // Cache this view for 1 day with the key "resume-cache" $this->view->cache( [ "lifetime" => 86400, "key" =>"resume-cache", ] ); }
public function downloadAction() { // Passing a custom service $this->view->cache( [ "service" =>"myCache", "lifetime" => 86400, "key" =>"resume-cache", ] ); } }
When we do not define a key to the cache, the component automatically creates one using an MD5 hash of the name of the controller and view currently being rendered in the format of “controller/view”. It is a good practice to define a key for each action so you can easily identify the cache associated with each view. When the View component needs to cache something it will request a cache service from the services container. The service name convention for this service is “viewCache”:
// Set the views cache service $di->set( "viewCache", function () { // Cache data for one day by default $frontCache= new OutputFrontend( [ "lifetime" => 86400, ] );
The frontend must always be Phalcon\Cache\Frontend\Output and the service ‘viewCache’ must be reg- istered as always open (not shared) in the services container (DI). When using views, caching can be used to prevent controllers from needing to generate view data on each request. To achieve this we must identify uniquely each cache with a key. First we verify that the cache does not exist or has expired to make the calculations/queries to display data in the view:
The PHP alternative site is an example of implementing the caching of fragments.
Template Engines
Template Engines help designers to create views without the use of a complicated syntax. Phalcon includes a powerful and fast templating engine called Volt. Additionally, Phalcon\Mvc\View allows you to use other template engines instead of plain PHP or Volt. Using a different template engine, usually requires complex text parsing using external PHP libraries in order to generate the final output for the user. This usually increases the number of resources that your application will use. If an external template engine is used, Phalcon\Mvc\View provides exactly the same view hierarchy and it’s still possible to access the API inside these templates with a little more effort. This component uses adapters, these help Phalcon to speak with those external template engines in a unified way, let’s see how to do that integration.
Creating your own Template Engine Adapter
There are many template engines, which you might want to integrate or create one of your own. The first step to start using an external template engine is create an adapter for it. A template engine adapter is a class that acts as bridge between Phalcon\Mvc\View and the template engine itself. Usually it only needs two methods implemented: __construct() and render(). The first one receives the Phalcon\Mvc\View instance that creates the engine adapter and the DI container used by the application. The method render() accepts an absolute path to the view file and the view parameters set using $this->view->setVar(). You could read or require it when it’s necessary.
/** * Renders a view using the template engine * * @param string $path * @param array $params
*/ public function render($path, $params) { // Access view $view= $this->_view;
// Access options $options= $this->_options;
// Render the view // ... } }
Changing the Template Engine
You can replace the template engine completely or use more than one template engine at the same time. The method Phalcon\Mvc\View::registerEngines() accepts an array containing data that define the template engines. The key of each engine is an extension that aids in distinguishing one from another. Template files related to the particular engine must have those extensions. The order that the template engines are defined with Phalcon\Mvc\View::registerEngines() defines the relevance of execution. If Phalcon\Mvc\View finds two views with the same name but different extensions, it will only render the first one. If you want to register a template engine or a set of them for each request in the application. You could register it when the view service is created:
use Phalcon\Mvc\View;
// Setting up the view component $di->set( "view", function () { $view= new View();
// A trailing directory separator is required $view->setViewsDir("../app/views/");
// Set the engine $view->registerEngines( [ ".my-html" =>"MyTemplateAdapter", ] );
// Using more than one template engine $view->registerEngines( [ ".my-html" =>"MyTemplateAdapter", ".phtml" =>"Phalcon \\Mvc\\View\\Engine\\Php", ] );
There are adapters available for several template engines on the Phalcon Incubator
Injecting services in View
Every view executed is included inside a Phalcon\Di\Injectable instance, providing easy access to the application’s service container. The following example shows how to write a jQuery ajax request using a URL with the framework conventions. The service “url” (usually Phalcon\Mvc\Url) is injected in the view by accessing a property with the same name:
Stand-Alone Component
All the components in Phalcon can be used as glue components individually because they are loosely coupled to each other:
Hierarchical Rendering
Using Phalcon\Mvc\View in a stand-alone mode can be demonstrated below:
use Phalcon\Mvc\View;
$view= new View();
// A trailing directory separator is required $view->setViewsDir("../app/views/");
// Passing variables to the views, these will be created as local variables $view->setVar("someProducts", $products); $view->setVar("someFeatureEnabled", true);
// Start the output buffering $view->start();
// Render all the view hierarchy related to the view products/list.phtml $view->render("products","list");
// Finish the output buffering $view->finish(); echo $view->getContent();
A short syntax is also available:
$view= new View(); echo $view->getRender( "products", "list", [ "someProducts" => $products, "someFeatureEnabled" => true, ], function ($view){ // Set any extra options here
$view->setViewsDir("../app/views/");
$view->setRenderLevel( View::LEVEL_LAYOUT ); } );
Simple Rendering
Using Phalcon\Mvc\View\Simple in a stand-alone mode can be demonstrated below:
$view= new SimpleView();
// A trailing directory separator is required $view->setViewsDir("../app/views/");
// Render a view and return its contents as a string echo $view->render("templates/welcomeMail");
Phalcon\Mvc\View and Phalcon\Mvc\View\Simple are able to send events to an EventsManager if it is present. Events are triggered using the type “view”. Some events when returning boolean false could stop the active operation. The following events are supported: Event Name Triggered Can stop operation? beforeRender Triggered before starting the render process Yes beforeRenderView Triggered before rendering an existing view Yes afterRenderView Triggered after rendering an existing view No afterRender Triggered after completing the render process No notFoundView Triggered when a view was not found No The following example demonstrates how to attach listeners to this component:
use Phalcon\Events\Event; use Phalcon\Events\Manager as EventsManager; use Phalcon\Mvc\View;
$di->set( "view", function () { // Create an events manager $eventsManager= new EventsManager();
// Attach a listener for type "view" $eventsManager->attach( "view", function (Event $event, $view){ echo $event->getType(),"-", $view->getActiveRenderPath(), PHP_EOL; } );
$view= new View();
$view->setViewsDir("../app/views/");
// Bind the eventsManager to the view component $view->setEventsManager($eventsManager);
return $view; }, true );
The following example shows how to create a plugin that clean/repair the HTML produced by the render process using Tidy:
use Phalcon\Events\Event;
class TidyPlugin { public function afterRender(Event $event, $view) {
// Attach the plugin as a listener $eventsManager->attach( "view:afterRender", new TidyPlugin() );
View Helpers (Tags)
Writing and maintaining HTML markup can quickly become a tedious task because of the naming conventions and nu- merous attributes that have to be taken into consideration. Phalcon deals with this complexity by offering Phalcon\Tag, which in turn offers view helpers to generate HTML markup. This component can be used in a plain HTML+PHP view or in a Volt template. This guide is not intended to be a complete documentation of available helpers and their arguments. Please visit the Phalcon\Tag page in the API for a complete reference.
Document Type of Content
Phalcon provides Phalcon\Tag::setDoctype() helper to set document type of the content. Document type setting may affect HTML output produced by other tag helpers. For example, if you set XHTML document type family, helpers that return or output HTML tags will produce self-closing tags to follow valid XHTML standard. Available document type constants in Phalcon\Tag namespace are:
Constant Document type HTML32 HTML 3.2 HTML401_STRICT HTML 4.01 Strict HTML401_TRANSITIONAL HTML 4.01 Transitional HTML401_FRAMESET HTML 4.01 Frameset HTML5 HTML 5 XHTML10_STRICT XHTML 1.0 Strict XHTML10_TRANSITIONAL XHTML 1.0 Transitional XHTML10_FRAMESET XHTML 1.0 Frameset XHTML11 XHTML 1.1 XHTML20 XHTML 2.0 XHTML5 XHTML 5 Setting document type.
$this->tag->setDoctype(Tag::HTML401_STRICT);
?>
Getting document type.
tag->getDoctype() ?>
The following HTML will be produced.
Volt syntax:
{{ get_doctype() }}
Generating Links
A real common task in any web application or website is to produce links that allow us to navigate from one page to another. When they are internal URLs we can create them in the following manner:
Forms in web applications play an essential part in retrieving user input. The following example shows how to implement a simple search form using view helpers:
Phalcon also provides a form builder to create forms in an object-oriented manner.
Helpers to Generate Form Elements
Phalcon provides a series of helpers to generate form elements such as text fields, buttons and more. The first parameter of each helper is always the name of the element to be generated. When the form is submitted, the name will be passed along with the form data. In a controller you can get these values using the same name by using the getPost() and getQuery() methods on the request object ($this->request).
tag->textField("username") ?>
tag->textArea( [ "comment", "This is the content of the text-area", "cols" =>"6", "rows" => 20, ] ) ?>
{{ text_area("comment", "This is the content", "cols": "6", "rows":20) }}
{{ password_field("password", "size":30) }}
{{ hidden_field("parent_id", "value": "5") }}
Making Select Boxes
Generating select boxes (select box) is easy, especially if the related data is stored in PHP associative arrays. The helpers for select elements are Phalcon\Tag::select() and Phalcon\Tag::selectStatic(). Phalcon\Tag::select() has been was specifically designed to work with Phalcon\Mvc\Model, while Phalcon\Tag::selectStatic() can with PHP arrays.
// Creating a Select Tag with an empty option with default text echo $this->tag->select( [ "productId", $products, "using" =>[ "id", "name", ], "useEmpty" => true, "emptyText" =>"Please, choose one...", "emptyValue" =>"@", ] );
Volt syntax for above example:
{# Creating a Select Tag with an empty option with default text #} {{ select('productId', products, 'using':['id', 'name'], 'useEmpty': true, 'emptyText': 'Please, choose one...', 'emptyValue': '@') }}
Assigning HTML attributes
All the helpers accept an array as their first parameter which can contain additional HTML attributes for the element generated.
tag->textField( [ "price", "size" => 20, "maxlength" => 30, "placeholder" =>"Enter a price", ] ) ?> or using Volt:
{{ text_field("price", "size":20, "maxlength":30, "placeholder": "Enter a price") }}
The following HTML is generated:
Setting Helper Values
From Controllers
It is a good programming principle for MVC frameworks to set specific values for form elements in the view. You can set those values directly from the controller using Phalcon\Tag::setDefault(). This helper preloads a value for any helpers present in the view. If any helper in the view has a name that matches the preloaded value, it will use it, unless a value is directly assigned on the helper in the view.
use Phalcon\Mvc\Controller;
class ProductsController extends Controller { public function indexAction() { $this->tag->setDefault("color","Blue"); } }
At the view, a selectStatic helper matches the same index used to preset the value. In this case “color”:
A special feature that the Phalcon\Tag helpers have is that they keep the values of form helpers between requests. This way you can easily show validation messages without losing entered data.
Specifying values directly
Every form helper supports the parameter “value”. With it you can specify a value for the helper directly. When this parameter is present, any preset value using setDefault() or via request will be ignored.
Changing dynamically the Document Title
Phalcon\Tag offers helpers to change dynamically the document title from the controller. The following example demonstrates just that:
use Phalcon\Mvc\Controller;
class PostsController extends Controller { public function initialize() { $this->tag->setTitle("Your Website"); }
public function indexAction() { $this->tag->prependTitle("Index of Posts -"); } }
Phalcon\Tag also provide helpers to generate tags such as script, link or img. They aid in quick and easy generation of the static resources of your application
Situasi umum ketika menyisipkan data tidak aman adalah antara tag HTML:
Anda dapat escape data tersebut dengan metode escapeHtml:
escapeHtml('>
myattack
'); ?>
Yang menghasilkan:
></div><h1>myattack</h1>
Escape Attribut HTML
Escape atribut HTML berbeda dari escape konten HTML. Escaper bekerja dengan mengubah tiap karakter bukan alfanumerik ke bentuk itu. Escape macam ini ditujukan untuk atribut paling sederhana dan tidak menyertakan atribut komplek seperti ‘href’ atau ‘url’:
Hello
Anda dapat escape atribut HTML menggunakan metode escapeHtmlAttr:
Phalcon\Validation is an independent validation component that validates an arbitrary set of data. This component can be used to implement validation rules on data objects that do not belong to a model or collection. The following example shows its basic usage:
$validation= new Validation();
$validation->add( "name", new PresenceOf( [ "message" =>"The name is required", ] ) );
$validation->add( "email", new PresenceOf( [ "message" =>"The e-mail is required", ] ) );
$validation->add( "email", new Email( [ "message" =>"The e-mail is not valid", ] ) );
$messages= $validation->validate($_POST); if (count($messages)) { foreach ($messages as $message){ echo $message," "; } }
The loosely-coupled design of this component allows you to create your own validators along with the ones provided by the framework.
Validation chains can be initialized in a direct manner by just adding validators to the Phalcon\Validation object. You can put your validations in a separate file for better re-use code and organization:
add( "name", new PresenceOf( [ "message" =>"The name is required", ] ) );
$this->add( "email", new PresenceOf( [ "message" =>"The e-mail is required", ] ) );
$this->add( "email", new Email( [ "message" =>"The e-mail is not valid", ] ) ); } }
Then initialize and use your own validator:
$validation= new MyValidation();
$messages= $validation->validate($_POST); if (count($messages)) { foreach ($messages as $message){ echo $message," "; } }
Phalcon exposes a set of built-in validators for this component: The following example explains how to create additional validators for this component:
getValue($attribute);
if (!filter_var($value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4| FILTER_FLAG_
˓→IPV6)) { $message= $this->getOption("message");
if (!$message){ $message="The IP is not valid"; }
$validator->appendMessage( new Message($message, $attribute,"Ip") );
return false; }
return true; } }
It is important that validators return a valid boolean value indicating if the validation was successful or not.
Validation Messages
Phalcon\Validation has a messaging subsystem that provides a flexible way to output or store the validation messages generated during the validation processes. Each message consists of an instance of the class Phalcon\Validation\Message. The set of messages generated can be retrieved with the getMessages() method. Each message provides extended information like the attribute that generated the message or the message type:
You can pass a ‘message’ parameter to change/translate the default message in each validator:
$validation->add( "email", new Email( [ "message" =>"The e-mail is not valid", ] ) );
By default, the getMessages() method returns all the messages generated during validation. You can filter mes- sages for a specific field using the filter() method:
$messages= $validation->validate(); if (count($messages)) { // Filter only the messages generated for the field 'name' $filteredMessages= $messages->filter("name");
foreach ($filteredMessages as $message){ echo $message; } }
Filtering of Data
Data can be filtered prior to the validation ensuring that malicious or incorrect data is not validated.
$validation= new Validation();
$validation->add( "name", new PresenceOf( [ "message" =>"The name is required", ]
$validation->add( "email", new PresenceOf( [ "message" =>"The email is required", ] ) );
// Filter any extra space $validation->setFilters("name","trim"); $validation->setFilters("email","trim");
Filtering and sanitizing is performed using the filter component. You can add more filters to this component or use the built-in ones.
Validation Events
When validations are organized in classes, you can implement the beforeValidation() and afterValidation() methods to perform additional checks, filters, clean-up, etc. If the beforeValidation() method returns false the validation is automatically cancelled:
/** * Executed before validation * * @param array $data * @param object $entity * @param Phalcon\Validation\Message\Group $messages * @return bool */ public function beforeValidation($data, $entity, $messages) { if ($this->request->getHttpHost() !=="admin.mydomain.com"){ $messages->appendMessage( new Message("Only users can log on in the administration domain") );
/** * Executed after validation * * @param array $data * @param object $entity * @param Phalcon\Validation\Message\Group $messages */ public function afterValidation($data, $entity, $messages) { // ... Add additional messages or perform more validations } }
Cancelling Validations
By default all validators assigned to a field are tested regardless if one of them have failed or not. You can change this behavior by telling the validation component which validator may stop the validation:
$validation= new Validation();
$validation->add( "telephone", new PresenceOf( [ "message" =>"The telephone is required", "cancelOnFail" => true, ] ) );
$validation->add( "telephone", new Regex( [ "message" =>"The telephone is required", "pattern" =>"/\+44 [0-9]+/", ] ) );
$validation->add( "telephone", new StringLength( [ "messageMinimum" =>"The telephone is too short", "min" =>2, ] ) );
The first validator has the option ‘cancelOnFail’ with a value of true, therefore if that validator fails the remaining
2.3. Components 389 Phalcon PHP Framework Documentation, Release 3.1.1 validators in the chain are not executed. If you are creating custom validators you can dynamically stop the validation chain by setting the ‘cancelOnFail’ option:
setOption("cancelOnFail", true); }
// ... } }
Avoid validate empty values
You can pass the option ‘allowEmpty’ to all the built-in validators to avoid the validation to be performed if an empty value is passed:
$validation= new Validation();
$validation->add( "telephone", new Regex( [ "message" =>"The telephone is required", "pattern" =>"/\+44 [0-9]+/", "allowEmpty" => true, ] ) );
You can also run Validation instances within another via the afterValidation() method. In this example, validating the CompanyValidation instance will also check the PhoneValidation instance:
public function initialize() { $this->phoneValidation= new PhoneValidation(); }
public function afterValidation($data, $entity, $messages) { $phoneValidationMessages= $this->phoneValidation->validate( $data["phone"] );
Forms can be rendered based on the form definition:
Contacts
Each element in the form can be rendered as required by the developer. Internally, Phalcon\Tag is used to produce the correct HTML for each element and you can pass additional HTML attributes as the second parameter of render():
render("name",["maxlength" => 30,"placeholder" =>"Type your
˓→name"]); ?>
HTML attributes also can be set in the element’s definition:
$form->add( new Text( "name", [ "maxlength" => 30, "placeholder" =>"Type your name", ] ) );
Initializing forms
As seen before, forms can be initialized outside the form class by adding elements to it. You can re-use code or organize your form classes implementing the form in a separated file:
add( new Text( "name" ) );
$this->add( new Text( "telephone" ) );
$this->add( new Select( "telephoneType", TelephoneTypes::find(), [ "using" =>[
foreach ($messages as $message){ echo $message," "; } }
Validators are executed in the same order as they were registered. By default messages generated by all the elements in the form are joined so they can be traversed using a single foreach, you can change this behavior to get the messages separated by the field:
A form is also able to filter data before it is validated. You can set filters in each element:
use Phalcon\Forms\Element\Text;
$name= new Text( "name" );
// Set multiple filters $name->setFilters( [ "string", "trim", ] );
$form->add($name);
$email= new Text( "email" );
// Set one filter $email->setFilters( "email" );
$form->add($email);
Learn more about filtering in Phalcon by reading the Filter documentation.
Forms + Entities
An entity such as a model/collection/plain instance or just a plain PHP class can be linked to the form in order to set default values in the form’s elements or assign the values from the form to the entity easily:
Entities can implement getters, which have a higher precedence than public properties. These methods give you more freedom to produce values:
public $receiveEmails;
public function getTimezone() { return "Europe/Amsterdam"; }
public function getReceiveEmails() { return "No"; } }
Form Elements
Phalcon provides a set of built-in elements to use in your forms, all these elements are located in the Phal- con\Forms\Element namespace: Name Description Phalcon\Forms\Element\Text Generate INPUT[type=text] elements Phalcon\Forms\Element\Password Generate INPUT[type=password] elements Phalcon\Forms\Element\Select Generate SELECT tag (combo lists) elements based on choices Phalcon\Forms\Element\Check Generate INPUT[type=check] elements Phalcon\Forms\Element\TextArea Generate TEXTAREA elements Phalcon\Forms\Element\Hidden Generate INPUT[type=hidden] elements Phalcon\Forms\Element\File Generate INPUT[type=file] elements Phalcon\Forms\Element\Date Generate INPUT[type=date] elements Phalcon\Forms\Element\Numeric Generate INPUT[type=number] elements Phalcon\Forms\Element\Submit Generate INPUT[type=submit] elements
Event Callbacks
Whenever forms are implemented as classes, the callbacks: beforeValidation() and afterValidation() can be implemented in the form’s class to perform pre-validations and post-validations:
public function render($attributes= null) { $html= // ... Produce some HTML
return $html; } }
Forms Manager
This component provides a forms manager that can be used by the developer to register forms and access them via the service locator:
use Phalcon\Forms\Manager as FormsManager;
$di["forms"]= function () { return new FormsManager(); };
Forms are added to the forms manager and referenced by a unique name:
$this->forms->set( "login", new LoginForm() );
Using the unique name, forms can be accessed in any part of the application:
$loginForm= $this->forms->get("login");
echo $loginForm->render();
External Resources
• Vökuró, is a sample application that uses the forms builder to create and manage forms, [Github]
Membaca Konfigurasi
Phalcon\Config adalah komponen yang digunakan untuk membaca file konfigurasi beragam format (menggunakan adapter) ke dalam objek PHP untuk digunakan dalam aplikasi.
Array Native
Contoh berikut menunjukkan bagaimana mengubah array native ke objek Phalcon\Config. Pilihan ini menawarkan performa terbaik karena tidak ada file yang dibaca selama request.
Jika anda ingi mengelola projek anda lebih baik anda dapat menyimpan array ke file lain dan membacanya.
use Phalcon\Config;
require "config/config.php";
$config= new Config($settings);
File Adapters
Adapter yang tersedia: Tipe File Keterangan Phal- Menggunakan file INI untuk menyimpan setting. Didalamnya adapter menggunakan con\Config\Adapter\Ini fungsi PHP parse_ini_file. Phal- Uses JSON files to store settings. con\Config\Adapter\Json Phal- Uses PHP multidimensional arrays to store settings. This adapter offers the best con\Config\Adapter\Php performance. Phal- Uses YAML files to store settings. con\Config\Adapter\Yaml
Membaca file INI
File Ini adalah cara umum menyimpan setting. Phalcon\Config menggunakan fungsi PHP parse_ini_file untuk mem- baca file. Seksi file dipecah menjadi sub setting untuk akses lebih mudah.
Phalcon\Config dapat menggabung properti satu objek konfigurasi ke lainnya secara rekursif. Properti baru ditam- bahkan dan properti yang sudah ada diperbarui.
Ada lebih banyak adapter tersedia untuk komponen ini di Phalcon Incubator
Injeksi ketergantungan Konfigurasi
Ada dapat menginjeksi ketergantungan terhadap konfigurasi ke kontroller yang memungkinkan kita menggunakan Phalcon\Config dalam Phalcon\Mvc\Controller. Agar dapat melakukannya, tambahkan kode berikut dalam script dependency injector.
// Buat DI $di= new FactoryDefault();
$di->set( "config", function () { $configData= require "config/config.php";
return new Config($configData); } );
Sekarang dalam kontroller anda dapat mengakses konfigurasi memanfaatkan fitur depedency injection dengan nama config seperti kode berikut:
The process of pagination takes place when we need to present big groups of arbitrary data gradually. Phalcon\Paginator offers a fast and convenient way to split these sets of data into browsable pages.
Data Adapters
This component makes use of adapters to encapsulate different sources of data: Adapter Description Phal- Use a PHP array as source data con\Paginator\Adapter\NativeArray Phal- Use a Phalcon\Mvc\Model\Resultset object as source data. Since PDO doesn’t support con\Paginator\Adapter\Modelscrollable cursors this adapter shouldn’t be used to paginate a large number of records Phal- Use a Phalcon\Mvc\Model\Query\Builder object as source data con\Paginator\Adapter\QueryBuilder
Examples
In the example below, the paginator will use the result of a query from a model as its source data, and limit the displayed data to 10 records per page:
// Current page to show // In a controller/component this can be: // $this->request->getQuery("page", "int"); // GET // $this->request->getPost("page", "int"); // POST $currentPage= (int) $_GET["page"];
// The data set to paginate $robots= Robots::find();
// Create a Model paginator, show 10 rows by page starting from $currentPage $paginator= new PaginatorModel( [ "data" => $robots, "limit" => 10, "page" => $currentPage, ] );
// Get the paginated results $page= $paginator->getPaginate();
The $currentPage variable controls the page to be displayed. The $paginator->getPaginate() returns a $page object that contains the paginated data. It can be used for generating the pagination:
The $page object has the following attributes: Attribute Description items The set of records to be displayed at the current page current The current page before The previous page to the current one next The next page to the current one last The last page in the set of records total_pages The number of pages total_items The number of items in the source data
Implementing your own adapters
The Phalcon\Paginator\AdapterInterface interface must be implemented in order to create your own paginator adapters or extend the existing ones:
/** * Set the current page number * * @param int $page */ public function setCurrentPage($page);
/** * Returns a slice of the resultset to show in the pagination * * @return stdClass */ public function getPaginate(); }
Meningkatkan Performa dengan Cache
Phalcon menyediakan kelas Phalcon\Cache yang memumungkinkan akses lebih cepat ke data terproses yang sering digunakan. Phalcon\Cache ditulis dalam C, menghasilkan performa lebih tinggi dan menurunkan overhead ketika mengambil item dari backend. Kelas ini menggunakan struktur internal komponen frontend dan backend. Komponen front-end bertugas sebagai sumber input atau antar muka, sementara komponen backend menyediakan opsi penyim- panan bagi kelas.
Kapan mengimplementasi cache?
Meski komponen ini sangat cepat, mengimplementasinya dalam kasus ia tidak dibutuhkan dapat menyebabkan kehi- langan performa daripada kenaikan. Kami sarankan anda cek kasus ini sebelum menggunakna cache: • Anda membuat kalkulasi kompleks yang selalu menghasilkan hasil yang sama (jarang berubah) • Anda menggunakan banyak helper dan output yang dihasilkan hampir selalu sama • Anda mengakses database terus menerus dan data ini jarang berubah NOTE Bahkan seteleh mengimplementasi cache, anda harus cek hit rasio cache terhadap periode waktu. Ini dapat mudah dilakukan, khususnya untuk Memcache atau Apc, dengan tool relevan yang disediakan backend.
Perilaku Caching
Proses cache terbagi dua bagian: • Frontend: Bagian ini bertanggung jawab untuk menguji apakah key telah kedaluwarsa dan melakukan trans- formasi tambahan terhadap data sebelum disimpan dan setelah diambil dari backend. • Backend: Bagian ini bertanggung jawab untuk berkomunikasi, menulis/membaca data yang diperlukan fron- tend.
Caching Potongan Output
Output fragment adalah penggalan HTML atau teks yang dicache sebagaimana adanya dan dikembalikan apa adanya. Outputnya otomatis ditangkap dari fungsi ob_* atau output PHP sehingga dapat disimpan di cache. Contoh berikut menunjukkan penggunaannya. Kode tersebut menerima output yang dibangkitkan oleh PHP dan menyimpannya di sebuah file. Isi file diperbarui tiap 172800 detik (2 hari). Implementasi mekanisme caching ini memungkinkan kita memperoleh kenaikan performa dengan tidak mengeksekusi pemanggilan helper Phalcon\Tag::linkTo() kapanpun potongan kode tersebut dipanggil.
use Phalcon\Cache\Backend\File as BackFile; use Phalcon\Cache\Frontend\Output as FrontOutput;
// Buat output frontend. Cache file selama 2 hari $frontCache= new FrontOutput( [ "lifetime" => 172800, ] );
// Buat komponen yang akan menyimpan cache "Output" ke backend "File" // Set direktori cache, penting menambahkan "/" diakhir // untuk nama folder $cache= new BackFile( $frontCache, [ "cacheDir" =>"../app/cache/", ] );
// Get/Set cache file ke ../app/cache/my-cache.html $content= $cache->start("my-cache.html");
// Jika $content null maka isi akan dibuat untuk cache if ($content === null){ // Cetak tanggal dan waktu echo date("r");
// Buat link ke sign-up action echo Tag::linkTo( [ "user/signup", "Sign Up", "class" =>"signup-button", ] );
// Simpan output ke file cache $cache->save(); } else { // Echo output yang dicache echo $content; }
NOTE Pada contoh di atas, Kode kita tetap sama, mencetak output ke user seperti yang sudah dilakukannya sebelum- nya. Komponen cache kita secara transparan menangkap output dan menyimpannya dalam file cache (ketika cache dibuat) atau mengirimkan kembali ke user hasil pre-kompilasi dari pemanggilan sebelumnya, sehingga menghindari operasi yang mahal.
Caching Data Sembarang
Caching data sama pentingnya bagi aplikasi anda. Caching dapat menurunkan beban database dengan menggunakan ulang data yang sering digunakan (namun tidak berubah), sehingga mempercepat aplikasi anda.
Salah satu adapter caching adalah ‘File’. Yang paling penting untuk adapter ini adalah lokasi dimana file cache akan disimpan. Ini dikendalikan oleh opsi cacheDir yang wajib memiliki backslash diakhir.
// Cache file selama 2 days menggunakna Data frontend $frontCache= new FrontData( [ "lifetime" => 172800, ] );
// Buat komponen yang akan menyimpan cache "Data" ke "File" backend // Atur direktori file cache - penting untuk menambah "/" diakhir // folder $cache= new BackFile( $frontCache, [ "cacheDir" =>"../app/cache/", ] );
$cacheKey="robots_order_id.cache";
// Coba ambil record yang dicache $robots= $cache->get($cacheKey); if ($robots === null){ // $robots null karena cache kedaluwarsa atau data tidak ada // Buat panggilan database dan isi variabel $robots= Robots::find( [ "order" =>"id", ] );
// Simpan dalam cache $cache->save($cacheKey, $robots); }
use Phalcon\Cache\Frontend\Data as FrontData; use Phalcon\Cache\Backend\Libmemcached as BackMemCached;
// Cache data selama satu jam $frontCache= new FrontData( [ "lifetime" => 3600, ] );
// Buat komponen yang akan cache "Data" ke "Memcached" backend // Pengaturan koneksi Memcached $cache= new BackMemCached( $frontCache, [ "servers" =>[ [ "host" =>"127.0.0.1", "port" =>"11211", "weight" =>"1", ] ] ] );
$cacheKey="robots_order_id.cache";
// Coba ambil record yang dicache $robots= $cache->get($cacheKey); if ($robots === null){ // $robots null karena cache kedaluwarsa atau karena data tidak ada // Buat panggilan database dan isi variabel $robots= Robots::find( [ "order" =>"id", ] );
// Simpan di cache $cache->save($cacheKey, $robots); }
Elemen ditambakan ke cache diidentifikasi secara unik menggunakan sebuah key. Dalam hal File backend, key-nya adalah nama file aktual. Untuk menerima data dari cache cache, kita cukup memanggilnya menggunakan key unik. Jika key tidak ada, metode get akan mengembalikan null.
// Ambil produk dengan key "myProducts" $products= $cache->get("myProducts");
Jika anda ingin tahu key mana yang disimpan di cache, anda dapat memanggil metode queryKeys:
// Query all keys used in the cache $keys= $cache->queryKeys(); foreach ($keys as $key){ $data= $cache->get($key);
echo "Key=", $key," Data=", $data; }
// Query keys in the cache that begins with "my-prefix" $keys= $cache->queryKeys("my-prefix");
Menghapus data dari cache
Ada kalanya anda akan membutuhkan untuk menghapus entri cache (karena pembaruan pada data yang dicache). Yang diperlukan hanya key ke data yang disimpan bersamanya.
// Hapus sebuah item dengan key spesifik $cache->delete("someKey");
$keys= $cache->queryKeys();
// Hapus semua item dari cache foreach ($keys as $key){ $cache->delete($key); }
Menguji keberadaan cache
Dimungkinkan untuk menguji apakah sebuah cache sudah ada dengan key yang ada:
exists("someKey")) { echo $cache->get("someKey"); } else { echo "Cache does not exists!"; }
Masa hidup
“Masa hidup” adalah waktu dalam detik sebauh cache dapat hidup sebelum kedaluwarsa. Secara default, semua cache yang diciptakan menggunakan masa idup yang diatur dalam penciptaan frontend. Anda dapat mengatur masa hidup tertentu saat menciptakan atau mengambil data dari cache:
$robots= $cache->get($cacheKey); if ($robots === null){ $robots="some robots";
// Atur cache saat menyimpan $cache->save($cacheKey, $robots, 3600); }
Cache Banyak-Tingkat
Fitur komponen cache ini, megnizinkan developer untuk membuat implementasi cache banyak-tingkat. Fitur baru ini sangat berguna karena anda dapat menyimpan data sama di beberapa lokasi cache dengan masa hidup berbeda, membaca pertama kali dari adapter yang lebih cepat dan berakhir di yang paling lambat hingga data kedaluwarsa:
$ultraFastFrontend= new DataFrontend( [ "lifetime" => 3600, ] );
$fastFrontend= new DataFrontend( [ "lifetime" => 86400, ] );
Adapter frontend yang tersedia yang digunakan sebagai antarmuka atau sumber input cache adalah: Adapter Keterangan Phal- Membaca input dari standard PHP output con\Cache\Frontend\Output Phal- Digunakan untuk cache sembarang data PHP (big arrays, objects, text, dan lain-lain). Data con\Cache\Frontend\Datadiserialisasi sebelum disimpan di backend. Phal- Digunakan untuk cache data biner. Data. Data diserialisasi dengan base64_encode con\Cache\Frontend\Base64sebelum disimpan di backend. Phal- Data di encode dalam JSON sebelum disimpan backend. Di decode setelah dibaca. con\Cache\Frontend\JsonFrontend berguna untuk berbagi data dengan bahasa atau framework lain. Phal- Digunakan untu cache beragam data PHP (big arrays, objects, text, dan lain-lain). Data con\Cache\Frontend\Igbinarydiserialisasi menggunakan IgBinary sebelum disimpan di backend. Phal- Digunakan untuk cache beragam data PHP data tanpa serialisasi. con\Cache\Frontend\None
Interface Phalcon\Cache\FrontendInterface harus diimplementasi untuk dapat menciptakan adapter frontend anda atau mengembangkan yang sudah ada.
Adapter Backend
Adapter backend yang tersedia untuk menyimpan cache: Adapter Keterangan Info Ekstensi yang diperlukan Phalcon\Cache\Backend\File Menyimpan data ke file lokal Phal- Menyimpan data ke server memcached Mem- memcache con\Cache\Backend\Memcache cached Phalcon\Cache\Backend\Apc Menyimpan data ke Alternative PHP APC APC extension Cache (APC) Phal- Menyimpan data ke Mongo Database Mon- Mongo con\Cache\Backend\Mongo goDb Phal- Menyimpan data di in XCache XCache xcache extension con\Cache\Backend\Xcache Phal- Menyimpan data di Redis Redis redis extension con\Cache\Backend\Redis
Mengimplementasi adapter Backend anda sendiri
Interface Phalcon\Cache\BackendInterface harus diimplementasi untuk menciptakan adapter backend anda sendiri atau mengembangkan yang sudah ada.
Opsi File Backend
Backend ini akan menyimpan konten yang dicache ke file di server lokal. Opsi yang tersedia untuk backend ini: Option Keterangan prefix Sebuah prefix yang otomatis ditambahkan didepan cache key cacheDir Direktori yang writable dimana file cache diletakkan
Opsi Memcached Backend
Backend ini akan menyimpan konten yang dicache di server memcached. Opsi yang tersedia untuk backend ini: Option Description prefix Sebuah prefix yang otomatis ditambahkan didepan cache key host memcached host port memcached port persistent Membuat koneksi persistent ke memcached?
APC Backend Options
Backend ini akan menyimpan konten yang dicache di Alternative PHP Cache (APC). Opsi yang tersedia untuk backend ini:
Option Keterangan prefix Sebuah prefix yang otomatis ditambahkan didepan cache key
Opsi Mongo Backend
Backend ini akan menyimpan konten yang dicache di server MongoDB. Opsi yang tersedia untuk backend ini: Option Keterangan prefix Sebuah prefix yang otomatis ditambahkan didepan cache key server MongoDB connection string db Mongo database name collection Mongo collection dalam database
Opsi XCache Backend
Backend ini akan menyimpan konten yang dicache di XCache (XCache). Opsi yang tersedia untuk backend ini: Option Keterangan prefix Sebuah prefix yang otomatis ditambahkan didepan cache key
Opsi Redis Backend
Backend ini akan menyimpan konten yang dicache di server Redis (Redis). Opsi yang tersedia untuk backend ini: Option Description prefix Sebuah prefix yang otomatis ditambahkan didepan cache key host Redis host port Redis port auth Password untuk autentikasi ke server Redis yang dilindungi password persistent Menciptakan koneksi persistent ke Redis index Index database Redis database yang digunakan Ada lebih banyak adapter tersedia untuk komponen ini di Phalcon Incubator
Security
This component aids the developer in common security tasks such as password hashing and Cross-Site Request Forgery protection (CSRF).
Password Hashing
Storing passwords in plain text is a bad security practice. Anyone with access to the database will immediately have access to all user accounts thus being able to engage in unauthorized activities. To combat that, many applications use the familiar one way hashing methods “md5” and “sha1”. However, hardware evolves each day, and becomes faster, these algorithms are becoming vulnerable to brute force attacks. These attacks are also known as rainbow tables. To solve this problem we can use hash algorithms as bcrypt. Why bcrypt? Thanks to its “Eksblowfish” key setup algorithm we can make the password encryption as “slow” as we want. Slow algorithms make the process to calculate the real password behind a hash extremely difficult if not impossible. This will protect your for a long time from a possible attack using rainbow tables. This component gives you the ability to use this algorithm in a simple way:
// Store the password hashed $user->password= $this->security->hash($password);
$user->save(); } }
We saved the password hashed with a default work factor. A higher work factor will make the password less vulnerable as its encryption will be slow. We can check if the password is correct as follows:
$user= Users::findFirstByLogin($login); if ($user){ if ($this->security->checkHash($password, $user->password)) { // The password is valid } } else { // To protect against timing attacks. Regardless of whether a user exists
˓→or not, the script will take roughly the same amount as it will always be computing
˓→a hash. $this->security->hash(rand()); }
// The validation has failed } }
The salt is generated using pseudo-random bytes with the PHP’s function openssl_random_pseudo_bytes so is required to have the openssl extension loaded.
This is another common attack against web sites and applications. Forms designed to perform tasks such as user registration or adding comments are vulnerable to this attack. The idea is to prevent the form values from being sent outside our application. To fix this, we generate a random nonce (token) in each form, add the token in the session and then validate the token once the form posts data back to our application by comparing the stored token in the session to the one submitted by the form:
Then in the controller’s action you can check if the CSRF token is valid:
request->isPost()) { if ($this->security->checkToken()) { // The token is OK } } } }
Remember to add a session adapter to your Dependency Injector, otherwise the token check won’t work:
$di->setShared( "session", function () { $session= new \Phalcon\Session\Adapter\Files();
$session->start();
return $session; } );
Adding a captcha to the form is also recommended to completely avoid the risks of this attack.
Setting up the component
This component is automatically registered in the services container as ‘security’, you can re-register it to setup its options:
Phalcon menyediakan fasilitas enkripsi melalui komponen Phalcon\Crypt. Kelas ini menawarkan pembungkus beror- ientasi objek sederhana ke pustaka enkripsi openssl milik PHP. Secara default, komponen ini menyediakan enkripsi aman menggunakan AES-256-CFB. Anda harus menggunakan panjang key sesuai algoritma saat ini. Untuk algoritma yang digunakan secara default ukurannya 32 bytes.
Penggunaan Dasar
Komponen ini dirancang untuk menyediakan cara penggunaan sangat sederhana:
// Buat instance $crypt= new Crypt();
$key="This is a secret key (32 bytes)."; $text="This is the text that you want to encrypt.";
Anda dapat menggunakan instance sama untuk enkripsi/dekripsi beberapa kali:
// Buat instance $crypt= new Crypt();
$texts=[ "my-key" =>"This is a secret text", "other-key" =>"This is a very secret", ]; foreach ($texts as $key => $text){ // Lakukan enkripsi $encrypted= $crypt->encrypt($text, $key);
// Sekarang dekripsi echo $crypt->decrypt($encrypted, $key); }
Opsi Enkripsi
Opsi berikut tersedia untuk mengubah perilaku enkripsi: Nama Keterangan Cipher Cipher adalah algoritma enkripsi yang didukung openssl. Anda dapat melihat daftarnya di sini
return $crypt; }, true ); lalu, contohnya, dalam sebuah kontroler anda dapat menggunakannya sebagai berikut:
$text= $this->request->getPost("text");
$secret->content= $this->crypt->encrypt($text);
if ($secret->save()) { $this->flash->success( "Secret was successfully created!" ); } } }
Access Control Lists (ACL)
Phalcon\Acl menghadirkan pengelolaan ACL yang mudah termasuk izin yang melekat padanya. Access Control Lists (ACL) memungkinkan sebuah aplikasi mengendalikan akses ke area aplikasi dan objek di dalamnya melalui request. Anda disarankan membaca lebih jauh tentang metodologi ACL agar familiar dengan konsepnya. Singkatnya, ACL memiliki role dan resource. Resource adalah objek yang mematuhi izin yang didefinisikan ter- hadapnya oleh ACL. Role adalah objek yang meminta akses ke resource dan dapat diberi atau ditolak oleh mekanisme ACL.
Menciptakan sebuah ACL
Komponen ini dirancang awalnya bekerja di memori. Hal ini memberikan kemudahan pakai dan kecepatan akses ke semua aspek di daftar. Konstruktor Phalcon\Acl parameter pertama mengharapkan sebuah adapter yang digunakan untuk mengambil informasi terkait control list. Contoh menggunakan adapter memori adalah sebagai berikut:
$acl= new AclList();
Defaultnya Phalcon\Acl mengizinkan akses ke aksi pada resource yang belum didefinisi. Untuk meningkatkan level keamanan access list, kita dapat mendefinisikan level “deny” sebagai level akses default.
// Aksi default adalah deny access $acl->setDefaultAction( Acl::DENY );
Menambahkan Role ke ACL
Sebuah role adalah objek yang bisa atau tidak bisa mengakses resource tertentu dalam access list. Sebagai contoh, kita akan mendefinisikan role sebagai sebuah grup orang dalam sebuah organisasi. Kelas Phalcon\Acl\Role tersedia untuk menciptakan role dengan cara yang lebih terstruktur. Mari kita tambahkan beberapa role ke dalam list yang baru kita ciptakan:
use Phalcon\Acl\Role;
// Tambahkan beberapa role. // Parameter pertama adalah nama dan parameter kedua adalah deskripsi tidak wajib. $roleAdmins= new Role("Administrators","Super-User role"); $roleGuests= new Role("Guests");
// Tambahkan "Guests" role ke ACL $acl->addRole($roleGuests);
// Tambahkan "Designers" role ke ACL tanpa menggunakan Phalcon\Acl\Role $acl->addRole("Designers");
Seperti yang bisa Anda lihat, role didefinisi langsung tanpa menggunakan instance.
Menambah Resource
Resource adalah objeck-objek yang aksesnya terkontrol. Normalnya dalam aplikasi MVC resource mengacu pada kon- troler. Meski tidak wajib, kelas Phalcon\Acl\Resource dapat digunakan untuk mendefinisikan resource. Hal penting adalah menambahkan aksi atau operasi terkait ke resource sehingga ACL dapat mengerti apa yang harus dikendalikan.
use Phalcon\Acl\Resource;
// Definisikan resource "Customers" $customersResource= new Resource("Customers");
// Tambahkan resource "customers" dengan beberapa operasi
Sekarang kita punya role dan resource, saatnya untuk mendefinisikan ACL (yaitu role yang dapat mengakses resource). Bagian ini sangat penting terutama menentukan default level akses “allow” atau “deny”.
// Set level akses role ke resource
$acl->allow("Guests","Customers","search");
$acl->allow("Guests","Customers","create");
$acl->deny("Guests","Customers","update");
Metode allow() memberikan role tersebut akses ke resource tertentu. Metode deny() melakukan sebaliknya.
Meminta ACL
Setelah daftar sudah terdefinisi. Kita dapat bertanya untuk menguji apakah sebuah role punya izin atau tidak.
Anda dapat juga menambahkan parameter ke-4 berupa fungsi kustom yang mengembalikan nilai boolean. Fungsi tersebut akan dipanggil ketika menggunakan metode isAllowed(). Anda dapat melewatkan parameter sebagai array asosiatif ke metode isAllowed() sebagai argumen ke-4 dimana key adalah nama parameter difungsi yang kita definisi.
Jika anda tidak menyediakan parameter di metode isAllowed() maka perilaku defaultnya adalah Acl::ALLOW. Anda dapat mengubahnya dengan menggunakan setNoArgumentsDefaultAction(). use Phalcon\Acl;
Anda dapat melewatkan objek sebagai roleName and resourceName. Kelas anda harus membuat implementasi Phalcon\Acl\RoleAware untuk roleName dan Phalcon\Acl\ResourceAware untuk resourceName. Kelas UserRole kita
// Buat kelas yang akan digunakan sebagai roleName class UserRole implements RoleAware { protected $id;
protected $roleName;
public function __construct($id, $roleName) { $this->id= $id; $this->roleName= $roleName; }
public function getId() { return $this->id; }
// Implementasi fungsi dari RoleAware Interface public function getRoleName() { return $this->roleName; } } dan kelas ModelResource
// Buat kelas yang akan digunakan sebagai resourceName class ModelResource implements ResourceAware { protected $id;
public function __construct($id, $resourceName, $userId) { $this->id= $id; $this->resourceName= $resourceName; $this->userId= $userId; }
public function getId() { return $this->id; }
public function getUserId() { return $this->userId; }
// Implementasi fungsi ResourceAware Interface public function getResourceName() { return $this->resourceName; } }
Selanjutnya anda dapat menggunakannya dalam metode isAllowed().
// Set level akses role ke resource $acl->allow("Guests","Customers","search"); $acl->allow("Guests","Customers","create"); $acl->deny("Guests","Customers","update");
// Buat objek yang menyediakan roleName dan resourceName
$customer= new ModelResource( 1, "Customers", 2 );
Anda dapt mengakses objektersebut dalam fungsi kustom Anda di allow() atau deny(). Mereka otomatis akan diikat ke parameter menggunakan tipe dalam fungsi.
// Set level akses role ke resource dengan fungsi kustom $acl->allow( "Guests", "Customers", "search", function (UserRole $user, ModelResource $model){ // Kelas User dan Model wajib return $user->getId == $model->getUserId(); } );
$acl->allow( "Guests", "Customers", "create" );
$acl->deny( "Guests", "Customers", "update" );
// Buat objek yang menyediakan roleName and resourceName
Anda dapat menambah parameter kustom ke fungsi dan melewatkan array asosiatif dalam metode isAllowed(). Urutannya juga tidak penting.
Penurunan Role
Anda dapat membangun struktur role kompleks menggunakan inheritansi yang disediakan Phalcon\Acl\Role. Role dapat diturunkan dari role lain, sehingga memungkinan akses ke himpunan resource yang lebih luas atau lebih sempit. Untuk menggunakan penurunan role, anda perlu melewatkan role turunan sebagai parameter kedua pada pemanggilan metode, ketika menambah role ke daftar.
$roleAdmins= new Role("Administrators","Super-User role");
$roleGuests= new Role("Guests");
// Tambahkan role "Guests" ke ACL $acl->addRole($roleGuests);
// Tambahkan role "Administrators" yang diturunkan dari "Guests" $acl->addRole($roleAdmins, $roleGuests);
Serialisasi Daftar ACL
Untuk meningkatkan performa instance Phalcon\Acl dapat diserialisasi dan disimpan dalam APC, session, file text atau tabel database sehingga mereka dapat dimuat sesukanya tanpa perlu mendefinisi ulang seluruh daftar. Anda dapat melakukannya sebagai berikut:
// ...
// Uji apakah data ACL sudah ada if (!is_file("app/security/acl.data")) { $acl= new AclList();
// ... Definisi role, resource, akses, dan lain-lain
// Simpan daftar terserialisasi ke plain file file_put_contents( "app/security/acl.data", serialize($acl) ); } else { // Restore ACL object dari serialized file $acl= unserialize( file_get_contents("app/security/acl.data") ); }
// Gunakan ACL list seperlunya if ($acl->isAllowed("Guests","Customers","edit")) { echo "Access granted!"; } else { echo "Access denied :("; }
Sangat disarankan menggunakan adapter Memory selama pengembangan dan menggunakan salah satu adapter lain diproduksi.
Phalcon\Acl dapat mengirim event ke EventsManager jika ada. Event dipicu menggunakan tipe “acl”. Beberapa event ketika mengembalikan nilai boolean false dapat menghentikan operasi yang aktif. Event berikut ini didukung: Nama Event Dipicu Bisa stop operasi? beforeCheckAccess Dipicu sebelum menguji apakah role punya akses Yes afterCheckAccess Dipicu sesudah menguji apakah role punya akses No Contoh berikut menunjukkan bagaimana memasang listener ke komponen ini:
use Phalcon\Acl\Adapter\Memory as AclList; use Phalcon\Events\Event; use Phalcon\Events\Manager as EventsManager;
// ...
// Buat event manager $eventsManager= new EventsManager();
// Pasangkan listener tipe "acl" $eventsManager->attach( "acl:beforeCheckAccess", function (Event $event, $acl){ echo $acl->getActiveRole();
echo $acl->getActiveResource();
echo $acl->getActiveAccess(); } );
$acl= new AclList();
// Setup $acl // ...
// Ikat eventsManager ke komponen ACL $acl->setEventsManager($eventsManager);
Implementasi adapter Anda sendiri
Interface Phalcon\Acl\AdapterInterface harus diimplementasi untuk menciptakan adapter ACL anda sendiri atau men- gubah yang sudah ada.
Multi-lingual Support
The component Phalcon\Translate aids in creating multilingual applications. Applications using this component, display content in different languages, based on the user’s chosen language supported by the application.
Adapters
This component makes use of adapters to read translation messages from different sources in a unified way.
Adapter Description Phal- Uses PHP arrays to store the messages. This is the best option in terms of con\Translate\Adapter\NativeArray performance.
Component Usage
Translation strings are stored in files. The structure of these files could vary depending of the adapter used. Phalcon gives you the freedom to organize your translation strings. A simple structure could be: app/messages/en.php app/messages/es.php app/messages/fr.php app/messages/zh.php
Each file contains an array of the translations in a key/value manner. For each translation file, keys are unique. The same array is used in different files, where keys remain the same and values contain the translated strings depending on each language.
// app/messages/en.php $messages=[ "hi" =>"Hello", "bye" =>"Good Bye", "hi-name" =>"Hello %name%", "song" =>"This song is %song%", ];
Implementing the translation mechanism in your application is trivial but depends on how you wish to implement it. You can use an automatic detection of the language from the user’s browser or you can provide a settings page where the user can select their language. A simple way of detecting the user’s language is to parse the $_SERVER['HTTP_ACCEPT_LANGUAGE'] contents, or if you wish, access it directly by calling $this->request->getBestLanguage() from an action/controller:
// Check if we have a translation file for that lang if (file_exists($translationFile)) { require $translationFile; } else { // Fallback to some default require "app/messages/en.php"; }
// Return a translation object return new NativeArray( [ "content" => $messages, ] ); }
public function indexAction() { $this->view->name="Mike"; $this->view->t= $this->getTranslation(); } }
The _getTranslation() method is available for all actions that require translations. The $t variable is passed to the views, and with it, we can translate strings in that layer:
_("hi"),"", $name; ?>
The _() method is returning the translated string based on the index passed. Some strings need to incorporate placeholders for calculated data i.e. Hello %name%. These placeholders can be replaced with passed parameters in the _() method. The passed parameters are in the form of a key/value array, where the key matches the placeholder name and the value is the actual data to be replaced:
_("hi-name",["name" => $name]); ?>
Some applications implement multilingual on the URL such as http://www.mozilla.org/es-ES/firefox/. Phalcon can implement this by using a Router.
Implementing your own adapters
The Phalcon\Translate\AdapterInterface interface must be implemented in order to create your own translate adapters or extend the existing ones:
use Phalcon\Translate\AdapterInterface;
class MyTranslateAdapter implements AdapterInterface { /**
* Adapter constructor * * @param array $data */ public function __construct($options);
/** * Returns the translation string of the given key * * @param string $translateKey * @param array $placeholders * @return string */ public function _($translateKey, $placeholders= null);
/** * Returns the translation related to the given key * * @param string $index * @param array $placeholders * @return string */ public function query($index, $placeholders= null);
/** * Check whether is defined a translation key in the internal array * * @param string $index * @return bool */ public function exists($index); }
There are more adapters available for this components in the Phalcon Incubator
Class Autoloader
Phalcon\Loader allows you to load project classes automatically, based on some predefined rules. Since this compo- nent is written in C, it provides the lowest overhead in reading and interpreting external PHP files. The behavior of this component is based on the PHP’s capability of autoloading classes. If a class that does not yet exist is used in any part of the code, a special handler will try to load it. Phalcon\Loader serves as the special handler for this operation. By loading classes on a need-to-load basis, the overall performance is increased since the only file reads that occur are for the files needed. This technique is called lazy initialization. With this component you can load files from other projects or vendors, this autoloader is PSR-0 and PSR-4 compliant. Phalcon\Loader offers four options to autoload classes. You can use them one at a time or combine them.
Security Layer
Phalcon\Loader offers a security layer sanitizing by default class names avoiding possible inclusion of unauthorized files. Consider the following example:
// Basic autoloader spl_autoload_register( function ($className){ $filepath= $className.".php";
if (file_exists($filepath)) { require $filepath; } } );
The above auto-loader lacks any kind of security. If a function mistakenly launches the auto-loader and a malicious prepared string is used as parameter this would allow to execute any file accessible by the application:
// This variable is not filtered and comes from an insecure source $className="../processes/important-process";
// Check if the class exists triggering the auto-loader if (class_exists($className)) { // ... }
If ‘../processes/important-process.php’ is a valid file, an external user could execute the file without authorization. To avoid these or most sophisticated attacks, Phalcon\Loader removes invalid characters from the class name, reducing the possibility of being attacked.
Registering Namespaces
If you’re organizing your code using namespaces, or using external libraries which do, the registerNamespaces() method provides the autoloading mechanism. It takes an associative array; the keys are namespace prefixes and their values are directories where the classes are located in. The namespace separator will be replaced by the directory separator when the loader tries to find the classes. Always remember to add a trailing slash at the end of the paths.
// file vendor/example/adapter/Some.php $some= new \Example\Adapter\Some();
Registering Directories
The third option is to register directories, in which classes could be found. This option is not recommended in terms of performance, since Phalcon will need to perform a significant number of file stats on each folder, looking for the file with the same name as the class. It’s important to register the directories in relevance order. Remember always add a trailing slash at the end of the paths.
// The required class will automatically include the file from // the first directory where it has been located // i.e. library/OtherComponent/Other/Some.php $some= new \Some();
Registering Classes
The last option is to register the class name and its path. This autoloader can be very useful when the folder convention of the project does not allow for easy retrieval of the file using the path and the class name. This is the fastest method of autoloading. However the more your application grows, the more classes/files need to be added to this autoloader, which will effectively make maintenance of the class list very cumbersome and it is not recommended.
// Creates the autoloader $loader= new Loader();
// Register some classes $loader->registerClasses( [ "Some" =>"library/OtherComponent/Other/Some.php", "Example\Base" =>"vendor/example/adapters/Example/BaseClass.php",
// Requiring a class will automatically include the file it references // in the associative array // i.e. library/OtherComponent/Other/Some.php $some= new \Some();
Registering Files
You can also registers files that are “non-classes” hence needing a “require”. This is very useful for including files that only have functions:
use Phalcon\Loader;
// Creates the autoloader $loader= new Loader();
// Register some classes $loader->registerFiles( [ "functions.php", "arrayFunctions.php", ] );
// Register autoloader $loader->register();
These files are automatically loaded in the register() method.
Additional file extensions
Some autoloading strategies such as “prefixes”, “namespaces” or “directories” automatically append the “php” exten- sion at the end of the checked file. If you are using additional extensions you could set it with the method “setExten- sions”. Files are checked in the order as it were defined:
use Phalcon\Loader;
// Creates the autoloader $loader= new Loader();
// Set file extensions to check $loader->setExtensions( [ "php", "inc", "phb",
In the following example, the EventsManager is working with the class loader, allowing us to obtain debugging information regarding the flow of operation:
Event Name Triggered Can stop operation? beforeCheckClass Triggered before starting the autoloading process Yes pathFound Triggered when the loader locate a class No afterCheckClass Triggered after finish the autoloading process. If this event is launched the autoloader didn’t find the class file No
Troubleshooting
Some things to keep in mind when using the universal autoloader: • Auto-loading process is case-sensitive, the class will be loaded as it is written in the code • Strategies based on namespaces/prefixes are faster than the directories strategy • If a cache bytecode like APC is installed this will used to retrieve the requested file (an implicit caching of the file is performed)
Logging
Phalcon\Logger adalah komponen yang kegunaannya menyediakan layanan logging bagi aplikasi. Ia menyediakan logging ke backend berbeda dengan adapter berbeda. Ia juga menyediakan logging transaksi, opsi konfigurasi format berbeda dan filter. Anda dapat menggunakan Phalcon\Logger untuk semua kebutuhan logging aplikasi Anda, mulai debugging proses hingga melacak alir aplikasi.
Adapter
Komponen ini memanfaatkan adapter untuk menyimpan pesan log. Penggunaan adapter memungkinkan antar muka umum bagi logging memudahkan berpindah backend jika diperlukan. Adapter yang didukung: Adapter Deskripsi Phalcon\Logger\Adapter\File Log ke plain text file Phalcon\Logger\Adapter\Stream Log ke PHP Streams Phalcon\Logger\Adapter\Syslog Log ke system logger Phalcon\Logger\Adapter\FirePHP Log ke FirePHP
Menciptakan Log
Contoh berikut menunjukkan bagaimana menciptakan sebuah log dan menambah pesan kedalamnya:
use Phalcon\Logger; use Phalcon\Logger\Adapter\File as FileAdapter;
$logger= new FileAdapter("app/logs/test.log");
// Ini adalah bermacam level log yang tersedia:
$logger->critical( "This is a critical message" );
// Anda dapat menggunakan metode log() dengan Logger constant: $logger->log( "This is another error message", Logger::ERROR );
// Jika tidak ditentukan diasumsikan Logger::DEBUG. $logger->log( "This is a message" );
// You can also pass context parameters like this $logger->log( "This is a{message}", [ 'message' => 'parameter' ] );
Log yang dihasilkan seperti berikut:
[Tue, 28 Jul 15 22:09:02 -0500][CRITICAL] This is a critical message [Tue, 28 Jul 15 22:09:02 -0500][EMERGENCY] This is an emergency message [Tue, 28 Jul 15 22:09:02 -0500][DEBUG] This is a debug message [Tue, 28 Jul 15 22:09:02 -0500][ERROR] This is an error message [Tue, 28 Jul 15 22:09:02 -0500][INFO] This is an info message [Tue, 28 Jul 15 22:09:02 -0500][NOTICE] This is a notice message [Tue, 28 Jul 15 22:09:02 -0500][WARNING] This is a warning message [Tue, 28 Jul 15 22:09:02 -0500][ALERT] This is an alert message
[Tue, 28 Jul 15 22:09:02 -0500][ERROR] This is another error message [Tue, 28 Jul 15 22:09:02 -0500][DEBUG] This is a message [Tue, 28 Jul 15 22:09:02 -0500][DEBUG] This is a parameter
Anda dapat mengatur level log menggunakan metode setLogLevel(). Metode ini membutuhkan Logger constant dan hanya akan menyimpan pesan log yang sama atau lebih penting dari nilai konstan:
use Phalcon\Logger; use Phalcon\Logger\Adapter\File as FileAdapter;
$logger= new FileAdapter("app/logs/test.log");
$logger->setLogLevel( Logger::CRITICAL );
Di contoh di atas, hanya pesan kritis dan darurat yang akan disimpan di log. Defaultnya, semua disimpan.
Transaksi
Logging data ke adapter misal File (file system) adalah operasi mahal ditinjau dari sisi performa. Untuk melawannya, anda dapat menggunakan transaksi logging. Transaksi menyimpan data log sementara di memori yang nanti ditulis ke adapter terkait (dalam hal ini File) dalam operasi atomik tunggal.
use Phalcon\Logger\Adapter\File as FileAdapter;
// Buat logger $logger= new FileAdapter("app/logs/test.log");
// Mulai transaksi $logger->begin();
// Tambahkan pesan
$logger->alert( "This is an alert" );
$logger->error( "This is another error" );
// Commit pesan ke file $logger->commit();
Logging ke Handlers lebih dari satu
Phalcon\Logger dapat mengirim pesan ke handler lebih dari satu dengan sekali pemanggilan:
use Phalcon\Logger; use Phalcon\Logger\Multiple as MultipleStream; use Phalcon\Logger\Adapter\File as FileAdapter; use Phalcon\Logger\Adapter\Stream as StreamAdapter;
$logger= new MultipleStream();
$logger->push( new FileAdapter("test.log") );
$logger->push( new StreamAdapter("php://stdout") );
$logger->log( "This is a message" );
$logger->log( "This is an error", Logger::ERROR );
$logger->error( "This is another error" );
Pesan tersebut akan dikirim ke handler sesuai urutan pendaftarannya.
Format Pesan
Komponen ini menggunakan ‘formatters’ untuk mengatur format pesan sebelum dikirim ke backend. Formatter yang tersedia: Adapter Keterangan Phalcon\Logger\Formatter\Line Format pesan dengan string satu baris Phalcon\Logger\Formatter\Firephp Format pesan agar dapat dikirim ke FirePHP Phalcon\Logger\Formatter\Json Siapkan pesan untuk di encode sebagai JSON Phalcon\Logger\Formatter\Syslog Siapkan pesan untuk diirim ke syslog
Line Formatter
Format pesan menggunakan string satu baris. Default format logging adalah:
[%date%][%type%] %message%
Anda dapat mengubah format default dengan setFormat(), ini memungkinkan anda mengubah format pesan log dengan mendefinsikan format anda sendiri. Format variabel yang diizinkan adalah:
Variabel Keterangan %message% Pesan yang akan di log %date% Tanggal pesan ditambahkan %type% Tipe pesan dalam format uppercase Contoh di bawah menunjukkan bagaimana mengubah format log:
use Phalcon\Logger\Formatter\Line as LineFormatter;
$formatter= new LineFormatter("%date% - %message%");
// Ubah format logger $logger->setFormatter($formatter);
Membuat formatter Anda sendiri
Interface Phalcon\Logger\FormatterInterface harus diimplementasi untuk dapat menciptakan formatter logger Anda atau mengubah yang sudah ada.
Adapters
Contoh berikut menunjukkan penggunaan dasar masing-masing adapter:
Stream Logger
Stream logger menulis pesan ke stream yang valid dalam PHP. Daftar stream yang tersedia di sini:
use Phalcon\Logger\Adapter\Stream as StreamAdapter;
// Buka stream dengan kompresi zlib $logger= new StreamAdapter("compress.zlib://week.log.gz");
// Tulis log ke stderr $logger= new StreamAdapter("php://stderr");
File Logger
Logger ini menggunakan plain file untuk menyimpan log beragam data. Defaultnya semua logger file dibuka dengan mode append yang membuka file untuk penulisan saja; dan menempatkan pointer di akhir file. Jika file tidak ada, maka file akan dicoba dibuat. Anda dapat mengubah mode ini dengan melewatkan opsi tambahan ke konstruktor:
use Phalcon\Logger\Adapter\File as FileAdapter;
// Buat file logger dalam mode 'w' $logger= new FileAdapter( "app/logs/test.log",
Interface Phalcon\Logger\AdapterInterface harus diimplementasi untuk dapat menciptakan adapter logger Anda sendiri atau mengubah yang sudah ada.
Parser Anotasi
Ini kali pertama sebuah komponen parser anotasi ditulis dalam C untuk dunia PHP. Phalcon\Annotations adalah komponen umum yang menyediakan parsing dan caching anotasi dalam kelas PHP untuk digunakan dalam aplikasi. Anotasi dibaca dari docblocks dalam kelas, metode dan properti. Sebuah anotasi dapat ditempatkan di sembarang posisi dalam docblock:
/** * Ini deskripsi kelas * * @AmazingClass(true) */ class Example { /** * Ini properti dengan fitur spesial * * @SpecialFeature */ protected $someProperty;
/** * Ini metode * * @SpecialFeature */ public function someMethod() { // ... } }
Proses pembacaan anotasi sangat cepat, namun, untuk alasan performa diarankan untuk menyimpan anotasi yang sudah diparsing menggunakan adapter. Adapter menyimpan anotasi yang sudah diproses sehingga menghindari kebu- tuhan untuk melakukan parsing anotasi terus menerus. Phalcon\Annotations\Adapter\Memory dgunakan untuk contoh di atas. Adapter ini hanya menyimpan anotasi selama request berjalan dan untuk alasan ini, adapter ini hanya cocok untuk tahap pengembangan. Ada adapter lain untuk ditukar ketika aplikasi berada dalam tahap produksi.
Jenis Anotasi
Anotasi dapat memiliki parameter atau tidak. Sebuah parameter dapat berupa nilai literal sederhana (string, angka, boolean, null), array, hashed list atau anotasi lain:
Berikutnya kita akan menjelaskan contoh praktis penggunaan anotasi di aplikasi PHP:
Cache Enabler dengan Anotasi
Anggap kita ptelah menciptakan controller berikut dan anda ingin menciptakan plugin yang otomatis memulai cache ketika aksi terakhir yang dieksekusi ditandai sebagai datap di cache. Pertama, kita daftarkan sebuah plugin ke layanan Dispatcher untuk diberi thau ketika sebuah route dieksekusi:
$di["dispatcher"]= function () { $eventsManager= new EventsManager();
// Attach the plugin to 'dispatch' events $eventsManager->attach( "dispatch", new CacheEnablerPlugin() );
$dispatcher= new MvcDispatcher();
$dispatcher->setEventsManager($eventsManager);
return $dispatcher; };
CacheEnablerPlugin adalah plugin yang menyadap tiap aksi yang dieksekusi dispatcher dan menghidupkan cache jika diperlukan:
/** * Enables the cache for a view if the latest * executed action has the annotation @Cache */ class CacheEnablerPlugin extends Plugin { /** * This event is executed before every route is executed in the dispatcher
*/ public function beforeExecuteRoute(Event $event, Dispatcher $dispatcher) { // Parse the annotations in the method currently executed $annotations= $this->annotations->getMethod( $dispatcher->getControllerClass(), $dispatcher->getActiveMethod() );
// Check if the method has an annotation 'Cache' if ($annotations->has("Cache")) { // The method has the annotation 'Cache' $annotation= $annotations->get("Cache");
// Get the lifetime $lifetime= $annotation->getNamedParameter("lifetime");
$options=[ "lifetime" => $lifetime, ];
// Check if there is a user defined cache key if ($annotation->hasNamedParameter("key")) { $options["key"]= $annotation->getNamedParameter("key"); }
// Enable the cache for the current method $this->view->cache($options); } } }
Kita dapat menggunakan anotasi dalam sebuah kontroller:
}
/** * This is a comment * * @Cache(lifetime=86400) */ public function showAllAction() { $this->view->article= Articles::find(); }
* @Cache(key="my-key", lifetime=86400) */ public function showAction($slug) { $this->view->article= Articles::findFirstByTitle($slug); } }
Private/Public area dengan Anotasi
Anda dapat menggunakan anotasi untuk memberitahu ACL kontroller mana yang termasuk area adiminstratif:
/** * This is the security plugin which controls that users only have access to the ˓→modules they're assigned to */ class SecurityAnnotationsPlugin extends Plugin { /** * This action is executed before execute any action in the application * * @param Event $event * @param Dispatcher $dispatcher */ public function beforeDispatch(Event $event, Dispatcher $dispatcher) { // Possible controller class name $controllerName= $dispatcher->getControllerClass();
// Possible method name $actionName= $dispatcher->getActiveMethod();
// Get annotations in the controller class $annotations= $this->annotations->get($controllerName);
// The controller is private? if ($annotations->getClassAnnotations()->has("Private")) { // Check if the session variable is active? if (!$this->session->get("auth")) {
// The user is no logged redirect to login $dispatcher->forward( [ "controller" =>"session", "action" =>"login", ]
Komponen ini menggunakan adapter untuk cache atau tidak anotasi yang terproses sehingga meningkatkan performa dan menyediakan fasilitas untuk pengembangan/pengujian: Class Keterangan Phal- Anotasi ini dicache di moemori saja. Ketika request berakhir cache dibersihkan dan con\Annotations\Adapter\Memorymemuat ulang anotasi di tiap request. Adapter ini cocok untuk tahap pengembangan Phal- Anotasi yang sudah diparsing dan diproses disimpan permanent di file PHP untuk con\Annotations\Adapter\Filesmenaikkan performa. Adapter ini harus digunakan bersama bytecode cache. Phal- Anotasi yang sudah diparsing dan diproses disimpan permanent di APC cache untuk con\Annotations\Adapter\Apcmenaikkan performa. Ini adalah adapter yang lebih cepat Phal- Anotasi yang sudah diparsing dan diproses disimpan permanent di XCache cache untuk con\Annotations\Adapter\Xcachemenaikkan performa. Ini adalah adapter yang lebih cepat
Implementasi adapter Anda
Interface Phalcon\Annotations\AdapterInterface harus diimplementasi untuk bisa menciptakan adapter anotasi anda sendiri atau mengembangkan yang sudah ada.
Sumber Luar
• Tutorial: Creating a custom model’s initializer with Annotations
Aplikasi Command Line
Aplikasi CLI dijalankan dari command line. Mereka berguna untuk menjalankan cron job, script, utiliti dan lainnya.
Struktur
Struktur minimal aplikasi CLI terlihat seperti berikut: • app/config/config.php • app/tasks/MainTask.php • app/cli.php <– file bootstrap utama
Sebagai aplikasi Mvc biasa, sebuah file bootstrap digunakan untuk memulai aplikasi. Alih-alih index.php untuk mem- ulai aplikasi web, kita menggunakan file cli.php. Di bawah ini adalah contoh bootstrap yang digunakan untuk contoh ini.
// Menggunakan service container factory default CLI $di= new CliDI();
/** * Daftarkan autoloade dan daftarkan direktori task */ $loader= new Loader();
$loader->registerDirs( [ __DIR__."/tasks", ] );
$loader->register();
// Muat file konfigurasi (bila ada)
$configFile= __DIR__."/config/config.php"; if (is_readable($configFile)) { $config= include $configFile;
$di->set("config", $config); }
// Buat aplikasi konsol $console= new ConsoleApp();
try { // Handle argumen yang masuk $console->handle($arguments); } catch (\Phalcon\Exception $e){ echo $e->getMessage();
exit(255); }
Potongan kode ini dapat dijalankan menggunakan:
$ php app/cli.php
This is the default task and the default action
Tugas
Tugas nekerja mirip kontroller. Tiap aplikasi CLI butuh paling tidak satu MainTask dan mainAction dan tiap tugas butuh sebuah mainAction yang dijalankan bila tidak ada aksi yang diberikan secara eksplisit. Di bawah ini adalah contoh file app/tasks/MainTask.php:
Memroses parameter aksi
Dimungkinkan untuk melewatkan parameter ke aksi, kode untuk ini sudah dihadirkan di contoh bootstrap. Jika aplikasi jalan dengan parameter dan aksi berikut:
public function testAction() { echo "I will get printed too!". PHP_EOL; } }
Namun, lebih baik untuk menggunakan Phalcon\Cli\Task dan mengimplementasi logika ini disana.
Images
Phalcon\Image is the component that allows you to manipulate image files. Multiple operations can be performed on the same image object. This guide is not intended to be a complete documentation of available methods and their arguments. Please visit the API for a complete reference.
Adapters
This component makes use of adapters to encapsulate specific image manipulator programs. The following image manipulator programs are supported: Class Description Phalcon\Image\Adapter\Gd Requires the GD PHP extension. Phalcon\Image\Adapter\Imagick Requires the ImageMagick PHP extension.
Implementing your own adapters
The Phalcon\Image\AdapterInterface interface must be implemented in order to create your own image adapters or extend the existing ones.
Saving and rendering images
Before we begin with the various features of the image component, it’s worth understanding how to save and render these images.
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
// ...
// Overwrite the original image $image->save();
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
// ...
// Save to 'new-image.jpg' $image->save("new-image.jpg");
You can also change the format of the image:
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
// ...
// Save as a PNG file $image->save("image.png");
When saving as a JPEG, you can also specify the quality as the second parameter:
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
// ...
// Save as a JPEG with 80% quality $image->save("image.jpg", 80);
Resizing images
There are several modes of resizing: • \Phalcon\Image::WIDTH • \Phalcon\Image::HEIGHT • \Phalcon\Image::NONE • \Phalcon\Image::TENSILE • \Phalcon\Image::AUTO • \Phalcon\Image::INVERSE • \Phalcon\Image::PRECISE
The NONE constant ignores the original image’s ratio. Neither width and height are required. If a dimension is not specified, the original dimension will be used. If the new proportions differ from the original proportions, the image may be distorted and stretched.
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
Similar to the NONE constant, the TENSILE constant ignores the original image’s ratio. Both width and height are required. If the new proportions differ from the original proportions, the image may be distorted and stretched.
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
$image->resize( 400, 200, \Phalcon\Image::NONE );
$image->save("resized-image.jpg");
Cropping images
For example, to get a 100px by 100px square from the centre of the image:
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
// Put the watermark in the bottom right corner with a 10px margin $offsetX=($image->getWidth()- $watermark->getWidth()- 10); $offsetY=($image->getHeight()- $watermark->getHeight()- 10);
The blur() method takes a single parameter - an integer between 0 (no effect) and 100 (very blurry):
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
$image->blur(50);
$image->save("blurred-image.jpg");
Pixelating images
The pixelate() method takes a single parameter - the higher the integer, the more pixelated the image becomes:
$image= new \Phalcon\Image\Adapter\Gd("image.jpg");
$image->pixelate(10);
$image->save("pixelated-image.jpg");
Queueing
Activities like processing videos, resizing images or sending emails aren’t suitable to be executed online or in real time because it may slow the loading time of pages and severely impact the user experience. The best solution here is to implement background jobs. The web application puts jobs into a queue and which will be processed separately. While you can find more sophisticated PHP extensions to address queueing in your applications like RabbitMQ; Phalcon provides a client for Beanstalk, a job queueing backend inspired by Memcache. It’s simple, lightweight, and completely specialized for job queueing.
Attention: Some of the returns from queue methods require that the module Yaml be installed. Please refer to http://php.net/manual/book.yaml.php for more information. For PHP < 7, Yaml 1.3.0 is acceptable. For PHP >= 7, you will need to use Yaml >= 2.0.0.
Putting Jobs into the Queue
After connecting to Beanstalk you can insert as many jobs as required. You can define the message structure according to the needs of the application:
// Connect to the queue $queue= new Beanstalk( [ "host" =>"192.168.0.21", "port" =>"11300", ] );
// Insert the job in the queue $queue->put( [ "processVideo" => 4871, ] );
Available connection options are: Option Description Default host IP where the beanstalk server is located 127.0.0.1 port Connection port 11300 In the above example we stored a message which will allow a background job to process a video. The message is stored in the queue immediately and does not have a certain time to live. Additional options as time to run, priority and delay can be passed as second parameter:
// Insert the job in the queue with options $queue->put( [ "processVideo" => 4871, ], [ "priority" => 250, "delay" => 10, "ttr" => 3600, ] );
Op- Description tion pri- It’s an integer < 2**32. Jobs with smaller priority values will be scheduled before jobs with larger ority priorities. The most urgent priority is 0; the least urgent priority is 4,294,967,295. de- It’s an integer number of seconds to wait before putting the job in the ready queue. The job will be in the lay “delayed” state during this time. ttr Time to run – is an integer number of seconds to allow a worker to run this job. This time is counted from the moment a worker reserves this job. Every job put into the queue returns a “job id” which you can use to track the status of the job:
Once a job is placed into the queue, those messages can be consumed by a background worker which will have enough time to complete the task:
while (($job= $queue->peekReady()) !== false){ $message= $job->getBody();
var_dump($message);
$job->delete(); }
Jobs must be removed from the queue to avoid double processing. If multiple background jobs workers are imple- mented, jobs must be “reserved” so other workers don’t re-process them while other workers have them reserved:
while (($job= $queue->reserve()) !== false){ $message= $job->getBody();
var_dump($message);
$job->delete(); }
Our client implement a basic set of the features provided by Beanstalkd but enough to allow you to build applications implementing queues.
Lapisan Abstraksi Database
Phalcon\Db adalah komponen di belakang Phalcon\Mvc\Model yang memberi tenaga lapisan model dalam framework. Ia terdiri atas lapisan abstraksi independen terhadap sistem database, yang ditulis sepenuhnya dalam C. Komponen ini memungkinkan manipulasi database level bawah menggunakan model tradisional.
Panduan ini tidak dimaksudkan sebagai dokumentasi lengkap metode yang tersedia dan argumennya. Silakan kunjungi API untuk referensi lengkap.
Adapter Database
Komponen ini menggunakan adapter untuk membungkus detil spesifik sistem database. Phalcon menggunakan PDO untuk menyambung ke database. Engine database berikut didukung: Class Keterangan Phal- Sistem manajemen database relasional (RDBMS) yang paling banyak digunakan di dunia con\Db\Adapter\Pdo\Mysqlyang berjalan sebagai sebuah server yang meneyediakan akses banyak pengguna ke sejumlah database Phal- PostgreSQL adalah sistem database relasional open source yang bertenaga. Ia aktif con\Db\Adapter\Pdo\Postgresqldikembangkan lebih dari 15 tahun dan memiliki arsitektur teruji yang telah memperoleh reputasi untuk keandalan, integritasi data dan kebenaran. Phal- SQLite adalah pustaka software yang mengimplementasi engine SQL database con\Db\Adapter\Pdo\Sqlitetransaksional yang berdiri sendiri, tanpa server dan tanpa konfigurasi
Mengimplementasi Adapter anda sendiri
Interface Phalcon\Db\AdapterInterface harus diimplementasi untuk dapat menciptakan apater database anda sendiri atau mengembangkan yang sudah ada.
Dialek Database
Phalcon membungkus detil spesifik tiap engine database dalam dialek. Mereka menyediakan fungsi umum dan pem- bangkit SQL untuk adapter. Class Keterangan Phalcon\Db\Dialect\Mysql Dialek SQL spesifik untuk sistem database MySQL Phalcon\Db\Dialect\Postgresql Dialek SQL spesifik untuk sistem database PostgreSQL Phalcon\Db\Dialect\Sqlite Dialek SQL spesifik untuk sistem database SQLite
Mengimplementasi dialek anda sendiri
Interface Phalcon\Db\DialectInterface harus diimplementasi untuk dapat menciptakan dialek database anda sendiri atau mengembangkan yang sudah ada.
Menyambung ke Database
Untuk menciptakan koneksi harus dilakukan dengan menciptakan kelas adapter. Butuh sebuah array berisi parameter koneksi. Contoh dibawah menunjukkan bagaimana menciptakan sebuah koneksi dengan melewatkan parameter wajib dan tidak:
Phalcon\Db menyediakan beberapa metode untuk query baris ke tabel. Sintaks SQL spesifik target engine database diperlukan dalam hal ini:
$sql="SELECT id, name FROM robots ORDER BY name";
// Kirim pernyataan SQL ke sistem database $result= $connection->query($sql);
// Cetak nama tiap robot while ($robot= $result->fetch()) { echo $robot["name"]; }
// Dapatkan semua row dalam sebuah array $robots= $connection->fetchAll($sql); foreach ($robots as $robot){ echo $robot["name"]; }
// Ambil baris pertama saja $robot= $connection->fetchOne($sql);
Secara default pemanggilan ini menciptakan array dengan indeks asosiatif dan numerik. Anda dapat mengubah peri- laku ini menggunakan Phalcon\Db\Result::setFetchMode(). Mteode ini menerima sebuah konstan, yang menentukan tipe indeks yang diperlukan. Konstan Keterangan Phalcon\Db::FETCH_NUM Kembalikan array dengan indeks numerik Phalcon\Db::FETCH_ASSOC Kembalikan array dengan indeks asosiatif Phalcon\Db::FETCH_BOTH Kembalikan array dengan indeks asosiatif dan numerik Phalcon\Db::FETCH_OBJ Kembalikan objek daripada array
$sql="SELECT id, name FROM robots ORDER BY name"; $result= $connection->query($sql);
$result->setFetchMode(Phalcon\Db::FETCH_NUM); while ($robot= $result->fetch()) { echo $robot[0]; }
Phalcon\Db::query() mengembalikan instance Phalcon\Db\Result\Pdo. Objek ini membungkus semua fung- sionalitas terkait result set yang dikembalikan yakni menelusuri, mencari record tertentu, jumlah dan lain-lain.
$sql="SELECT id, name FROM robots"; $result= $connection->query($sql);
// Menelusuri resultset while ($robot= $result->fetch()) { echo $robot["name"]; }
// Mencari row ketiga $result->seek(2); $robot= $result->fetch();
// Hitung jumlah resultset echo $result->numRows();
Mengikat Parameter
Parameter terikat juga didukung Phalcon\Db. Meski ada dampak kecil di performa dengan menggunakan parameter terikat, anda disarankan untuk menggunakan metodologi ini untuk menghilangkan kemungkinan kode anda terkena serangan SQL injection. Baik string maupun positional placeholder didukung. Mengikat parameter dapat dilakukan seperti berikut:
// Mengikat dengan placeholder numerik $sql="SELECT * FROM robots WHERE name = ? ORDER BY name"; $result= $connection->query( $sql, [ "Wall-E", ] );
// Mengikat dengan placeholder bernama $sql="INSERT INTO `robots`(name`, year) VALUES (:name, :year)"; $success= $connection->query( $sql, [ "name" =>"Astro Boy", "year" => 1952, ] );
Ketika menggunakan placeholder numerik, anda akan harus menentukannya sebagai integer yakni 1 atau 2. Untuk kasus “1” atau “2” mereka dianggap string dan bukan integer, sehingga placeholder tidak dapat diganti dengan benar. Dengan sembarang adapter data otomatis di escape menggunakan PDO Quote. Fungsi ini memerhitungkan connection charset, sehingga disarankan untuk menentukan charset yang benar dalam parameter koneksi atau dalam konfigurasi server database, karena charset keliru akan menghasilkan dampak tidak diinginkan ketika menyimpan atau mangambil data. Anda dapat juga melewatkan parameter langsung ke metode execute/query. untuk hal ini parameter terikat langsung dilewatkan ke PDO:
// Mengikat placeholder PDO $sql="SELECT * FROM robots WHERE name = ? ORDER BY name"; $result= $connection->query( $sql, [ 1 =>"Wall-E", ] );
// Membangkitkan SQL yang diperlukan secara dinamis $success= $connection->delete( "robots", "id = ?", [ 101, ] );
Transaksi dan Transaksi Bersarang
Bekerja dengan transaksi didukung seperti halnya dengan PDO. Melakukan manipulasi data dalam transaksi sering kali menaikkan performa pada sebagian besar sistem database:
begin();
// Eksekusi beberapa pernyataan SQL $connection->execute("DELETE `robots` WHERE `id` = 101"); $connection->execute("DELETE `robots` WHERE `id` = 102"); $connection->execute("DELETE `robots` WHERE `id` = 103");
// Commit jika semuanya berjalan baik $connection->commit(); } catch (Exception $e){ // Exception terjadi rollback transaksi $connection->rollback(); }
Sebagai tambahan transaksi baku, Phalcon\Db menyediakan dukungan bawaan untuk transaksi bersarang (jika sistem database yang digunakan mendukung). Ketika anda memanggil begin() untuk kedua kali sebuah transaksi bersarang diciptakan:
begin();
// Eksekusi pernyataan SQL $connection->execute("DELETE `robots` WHERE `id` = 101");
try { // Mulai transaksi bersarang $connection->begin();
// Execute these SQL statements into the nested transaction $connection->execute("DELETE `robots` WHERE `id` = 102"); $connection->execute("DELETE `robots` WHERE `id` = 103");
// Buat save point $connection->commit(); } catch (Exception $e){
// Lanjutkan, eksekusi pernyataan SQL lain $connection->execute("DELETE `robots` WHERE `id` = 104");
// Commit jika semua berjalan baik $connection->commit(); } catch (Exception $e){ // Kesalahan terjadi, batalkan transaksi $connection->rollback(); }
Kejadian Database
Phalcon\Db mampu mengirim kejadian ke sebuah EventsManager jika ada. Beberapa kejadian yang ketika mengem- balikan nilai boolean false dapat menghentikan operasi yang aktif. Kejadian berikut didukung: Nama Event Dipicu Bisa stop operasi? afterConnect Setelah koneksi sukses ke sistem database Tidak beforeQuery Sebelum mengirim pernyataan SQL ke sistem database Ya afterQuery Setelah mengirim pernyataan SQL ke sistem database Tidak beforeDisconnect Sebelum menutup koneksi database sementara Tidak beginTransaction Sebelum memulai transaksi Tidak rollbackTransaction Sebelum membatalkan transaksi Tidak commitTransaction Sebelum commit transaksi Tidak Mengikat sebuah EventsManager ke sebuah koneksi mudah, Phalcon\Db akan memicu kejadian bertipe “db”:
use Phalcon\Events\Manager as EventsManager; use Phalcon\Db\Adapter\Pdo\Mysql as Connection;
$eventsManager= new EventsManager();
// Pantau semua kejadian database $eventsManager->attach('db', $dbListener);
$eventsManager->attach( "db:beforeQuery", function (Event $event, $connection){ $sql= $connection->getSQLStatement();
// Uji untuk kata-kata berbahaya dalam pernyataan SQL if (preg_match("/DROP|ALTER/i", $sql)) { // Operasi DROP/ALTER tidak izinkan di aplikasi ini, // Ini pastinya SQL injection! return false; }
// OK return true; } );
Profiling SQL Statements
Phalcon\Db menyertakan komponen profiling bernama Phalcon\Db\Profiler, yang digunakan untuk menganalisa per- forma operasi database juga mendiagnosa masalah performa dan menemukan bottleneck. Profiling database sangat mudah dengan Phalcon\Db\Profiler:
$eventsManager= new EventsManager();
$profiler= new DbProfiler();
// Pantau semua kejadian database $eventsManager->attach( "db", function (Event $event, $connection) use ($profiler){ if ($event->getType() ==="beforeQuery"){ $sql= $connection->getSQLStatement();
// Mulai profil koneksi aktif $profiler->startProfile($sql); }
if ($event->getType() ==="afterQuery"){ // Hentikan profil aktif $profiler->stopProfile(); } } );
// Salin eventsManager ke connection $connection->setEventsManager($eventsManager);
// Ambil profil terakhir dari profiler $profile= $profiler->getLastProfile(); echo "SQL Statement:", $profile->getSQLStatement()," \n"; echo "Start Time:", $profile->getInitialTime()," \n"; echo "Final Time:", $profile->getFinalTime()," \n"; echo "Total Elapsed Time:", $profile->getTotalElapsedSeconds()," \n";
Anda dapat menciptakan kelas profil anda sendiri berdasar Phalcon\Db\Profiler untuk merekam statistik real time perintah yang dikirim ke sistem database:
getSQLStatement(); }
/** * Dieksekusi setelah perintah SQL dikirim ke server db */ public function afterEndProfile(Item $profile) { echo $profile->getTotalElapsedSeconds(); } }
// Buat sebuah Events Manager $eventsManager= new EventsManager();
// Buat pemantau $dbProfiler= new DbProfiler();
// Pasang pemantau untuk memantau semua kejadian database $eventsManager->attach("db", $dbProfiler);
Log Perintah SQL
Menggunakan komponen abstraksi level tinggi seperti Phalcon\Db untuk mengakses sebuah database, sulit untuk memahami perintah apa yang dikirim ke sistem database. Phalcon\Logger berinteraksi dengan Phalcon\Db, menye-
Kode di atas, file app/logs/db.log akan berisi seperti ini:
[Sun, 29 Apr 12 22:35:26 -0500][DEBUG][Resource Id #77] INSERT INTO products (name, price) VALUES ('Hot pepper', 3.50)
Implementasi Logger anda sendiri
Anda dapat mengimplementasi kelas logger anda sendiri untuk query database, dengan menciptakan sebuah kelas yang mengimplementasi sebuah metode bernama “log”. Metode ini harus menerima string sebagai argumen pertama. Anda dapat melewatkan objek logging ke Phalcon\Db::setLogger(), dan dari sana tiap perintah SQL yang dijalankan akan memanggil metode tersebut untuk log result.
Deskripsi Tables/Views
Phalcon\Db juga menyediakan metode untuk mendapatkan informasi detil tentang tabel dan view:
// Ambil tabel pada database test_db $tables= $connection->listTables("test_db");
// Apakah ada tabel 'robots' dalam database? $exists= $connection->tableExists("robots");
// Ambil nama, tipe data dan fitur khusus field 'robots' $fields= $connection->describeColumns("robots"); foreach ($fields as $field){ echo "Column Type:", $field["Type"]; }
// Ambil indeks pada tabel 'robots' $indexes= $connection->describeIndexes("robots"); foreach ($indexes as $index){ print_r( $index->getColumns() ); }
// Ambil foreign keys pada tabel 'robots' $references= $connection->describeReferences("robots"); foreach ($references as $reference){ // Cetak kolom yang direferensi print_r( $reference->getReferencedColumns() ); }
Sebuah deksripsi tabel sangat mirip dengan perintah describe di MySQL, ia berisi informasi berikut: Indeks Keterangan Field Nama field Type Tipe kolom Key Apakah primary key atau index? Null Kolom ini mengizinkan nilai null? Metode untuk mendapatkan informasi tenant view juga diimplementasi untuk semua sistem database yang didukung:
// Ambil view pada database test_db $tables= $connection->listViews("test_db");
// Apakah ada view bernama 'robots' di database? $exists= $connection->viewExists("robots");
Creating/Altering/Dropping Tables
Sistem database berbeda (MySQL, Postgresql dan lain-lain.) menyediakan kemampuan untuk menciptakan, mengubah atau menghapus tabel dengan perintah seperti CREATE, ALTER atau DROP. Sintaks SQL berbeda berdasarkan pada sistem database yang digunakan. Phalcon\Db menawarkan antarmuka seragam untuk mengubah tabel, tanpa perlu membedakan sintaks SQL berdasarkan target sistem storage.
Phalcon\Db::createTable() menerima array asosiatif yang mendeskripsikan tabel. Kolom ditentukan dengan kelas Phalcon\Db\Column. tabel di bawah menunjukkan opsi yang tersedia untuk mendefinisikan kolom:
Option Keterangan Op- sional “type” Tipe kolom. Harus konstan Phalcon\Db\Column (lihat daftar dibawah) Tidak “primary” True jika kolom adalah primary key tabel Ya “size” Beberapa tipe kolom seperti VARCHAR atau INTEGER bisa memiliki size tertentu Ya “scale” Kolom DECIMAL atau NUMBER dapat memiliki skala untuk menentukan berapa Ya desimal yang disimpan “unsigned” Kolom INTEGER dapat berupa signed atau unsigned. Opsi ini tidak dapat diterapkan Ya untuk tipe kolom lain “notNull” Kolom dapat menyimpan nilai null? Ya “default” Nilai default (ketika digunakan dengan "notNull" => true). Ya “autoIncre- Dengan atribut ini kolom akan diisi dengan integer auto-increment. Hanya satu kolom Ya ment” dalam tabel yang bisa punya atribut ini. “bind” Salah satu konstant BIND_TYPE_* yang menjelaskan bahwiman kolom harus diikat Ya sebelum disimpan “first” Kolom harus ditempatkan di posisi pertama dalam urutan kolom Ya “after” Kolom harus ditempatkan setelah posisi kolom terindikasi Ya Phalcon\Db mendukung tipe kolom database berikut: • Phalcon\Db\Column::TYPE_INTEGER • Phalcon\Db\Column::TYPE_DATE • Phalcon\Db\Column::TYPE_VARCHAR • Phalcon\Db\Column::TYPE_DECIMAL • Phalcon\Db\Column::TYPE_DATETIME • Phalcon\Db\Column::TYPE_CHAR • Phalcon\Db\Column::TYPE_TEXT Array asosiatif yang dilewatkan dalam Phalcon\Db::createTable() dapat memiliki key berikut: Index Keterangan Op- sional “columns” Sebuah array dengan himpunan kolom tabel ditentukan oleh Phalcon\Db\Column Tidak “indexes” Sebuah array dengan himpunan indeks tabel ditentukan oleh Phalcon\Db\Index Ya “refer- Sebuah array dengan himpunan referensi tabel (foreign key) ditentukan oleh Ya ences” Phalcon\Db\Reference “options” Sebuah array dengan himpunan opsi pembuatan tabel. Opsi ini terkait dengan sistem Ya database yang migrasi dibuat. mengubah Tabel
Saat aplikasi anda tumbuh, anda mungkin perlu mengubah database anda, sebagai bagian dari refactoring atau menam- bah fitur baru. Tidak semua sistem database mengizinkan mengubah kolom yang sudah ada atau menamb kolom antara yang sudah ada. Phalcon\Db dibatasi oleh keterbatasan ini.
// Menambah kolom baru $connection->addColumn( "robots",
// Hapus tabel robot dari database aktif $connection->dropTable("robots");
// Hapus tabel robot dari database "machines" $connection->dropTable("robots","machines");
Internationalization
Phalcon is written in C as an extension for PHP. There is a PECL extension that offers internationalization functions to PHP applications called intl. Starting from PHP 5.4/5.5 this extension is bundled with PHP. Its documentation can be found in the pages of the official PHP manual. Phalcon does not offer this functionality, since creating such a component would be replicating existing code. In the examples below, we will show you how to implement the intl extension’s functionality into Phalcon powered applications.
// Locale could be something like "en_GB" or "en" echo $locale;
Below method returns a locale identified. It is used to get language, culture, or regionally-specific behavior from the Locale API. Examples of identifiers include: • en-US (English, United States) • ru-RU (Russian, Russia) • zh-Hant-TW (Chinese, Traditional Script, Taiwan) • fr-CA, fr-FR (French for Canada and France respectively)
Formatting messages based on Locale
Part of creating a localized application is to produce concatenated, language-neutral messages. The MessageFormatter allows for the production of those messages. Printing numbers formatted based on some locale:
// Prints C 4 560 $formatter= new MessageFormatter("fr_FR"," C{0, number, integer}"); echo $formatter->format([4560]);
// Prints USD$ 4,560.5 $formatter= new MessageFormatter("en_US","USD${0, number}"); echo $formatter->format([4560.50]);
// Prints ARS$ 1.250,25 $formatter= new MessageFormatter("es_AR","ARS${0, number}"); echo $formatter->format([1250.25]);
$pattern="At{1, time} on{1, date}, there was a disturbance on planet{0, number}
˓→."; $formatter= new MessageFormatter("en_US", $pattern); echo $formatter->format($values);
// Prints "À 15:53:01 le 19 avr. 2015, il y avait une perturbation sur la planète 7." $pattern="À{1, time} le{1, date}, il y avait une perturbation sur la planète{0,
˓→ number}."; $formatter= new MessageFormatter("fr_FR", $pattern); echo $formatter->format($values);
Locale-Sensitive comparison
The Collator class provides string comparison capability with support for appropriate locale-sensitive sort orderings. Check the examples below on the usage of this class:
// Create a collator using Spanish locale $collator= new Collator("es");
// Returns that the strings are equal, in spite of the emphasis on the "o" $collator->setStrength(Collator::PRIMARY); var_dump($collator->compare("una canción","una cancion"));
// Returns that the strings are not equal $collator->setStrength(Collator::DEFAULT_VALUE); var_dump($collator->compare("una canción","una cancion"));
Transliteration
Transliterator provides transliteration of strings:
Migrations are a convenient way for you to alter your database in a structured and organized manner. Important: Migrations are available in Phalcon Developer Tools You need at least Phalcon Framework version 0.5.0 to use developer tools. Also, it is recommended to have PHP 5.4 or greater installed. Often in development we need to update changes in production environments. Some of these changes could be database modifications like new fields, new tables, removing indexes, etc. When a migration is generated a set of classes are created to describe how your database is structured at that particular moment. These classes can be used to synchronize the schema structure on remote databases setting your database
ready to work with the new changes that your application implements. Migrations describe these transformations using plain PHP.
Schema Dumping
The Phalcon Developer Tools provides scripts to manage migrations (generation, running and rollback). The available options for generating migrations are:
Running this script without any parameters will simply dump every object (tables and views) from your database into migration classes. Each migration has a version identifier associated with it. The version number allows us to identify if the migration is newer or older than the current ‘version’ of our database. Versions will also inform Phalcon of the running order when executing a migration. When a migration is generated, instructions are displayed on the console to describe the different steps of the migration and the execution time of those statements. At the end, a migration version is generated. By default Phalcon Developer Tools uses the app/migrations directory to dump the migration files. You can change the location by setting one of the parameters on the generation script. Each table in the database has its respective class generated in a separated file under a directory referring its version:
Migration Class Anatomy
Each file contains a unique class that extends the Phalcon\Mvc\Model\Migration class. These classes nor- mally have two methods: up() and down(). up() performs the migration, while down() rolls it back. up() also contains the magic method morphTable(). The magic comes when it recognizes the changes needed to synchronize the actual table in the database to the description given.
The class is called “ProductsMigration_100”. Suffix 100 refers to the version 1.0.0. morphTable() receives an associative array with 4 possible sections: Index Description Op- tional “columns” An array with a set of table columns No “in- An array with a set of table indexes. Yes dexes” “refer- An array with a set of table references (foreign keys). Yes ences” “op- An array with a set of table creation options. These options are often related to the database Yes tions” system in which the migration was generated.
Defining Columns
Phalcon\Db\Column is used to define table columns. It encapsulates a wide variety of column related features. Its constructor receives as first parameter the column name and an array describing the column. The following options are available when describing columns:
Option Description Op- tional “type” Column type. Must be a Phalcon_Db_Column constant (see below) No “size” Some type of columns like VARCHAR or INTEGER may have a specific size Yes “scale” DECIMAL or NUMBER columns may be have a scale to specify how much decimals it Yes must store “un- INTEGER columns may be signed or unsigned. This option does not apply to other types Yes signed” of columns “notNull” Column can store null values? Yes “default” Defines a default value for a column (can only be an actual value, not a function such as Yes NOW()) “autoIn- With this attribute column will filled automatically with an auto-increment integer. Only Yes crement” one column in the table can have this attribute. “first” Column must be placed at first position in the column order Yes “after” Column must be placed after indicated column Yes Database migrations support the following database column types: • Phalcon\Db\Column::TYPE_INTEGER • Phalcon\Db\Column::TYPE_VARCHAR • Phalcon\Db\Column::TYPE_CHAR • Phalcon\Db\Column::TYPE_DATE • Phalcon\Db\Column::TYPE_DATETIME • Phalcon\Db\Column::TYPE_TIMESTAMP • Phalcon\Db\Column::TYPE_DECIMAL • Phalcon\Db\Column::TYPE_TEXT • Phalcon\Db\Column::TYPE_BOOLEAN • Phalcon\Db\Column::TYPE_FLOAT • Phalcon\Db\Column::TYPE_DOUBLE • Phalcon\Db\Column::TYPE_TINYBLOB • Phalcon\Db\Column::TYPE_BLOB • Phalcon\Db\Column::TYPE_MEDIUMBLOB • Phalcon\Db\Column::TYPE_LONGBLOB • Phalcon\Db\Column::TYPE_JSON • Phalcon\Db\Column::TYPE_JSONB • Phalcon\Db\Column::TYPE_BIGINTEGER
Defining Indexes
Phalcon\Db\Index defines table indexes. An index only requires that you define a name for it and a list of its columns. Note that if any index has the name PRIMARY, Phalcon will create a primary key index for that table.
Phalcon\Db\Reference defines table references (also called foreign keys). The following options can be used to define a reference: Index Description Op- Implemented tional in “refer- It’s auto-descriptive. It refers to the name of the referenced table. No All encedTable” “columns” An array with the name of the columns at the table that have the No All reference “referenced- An array with the name of the columns at the referenced table No All Columns” “referenced- The referenced table maybe is on another schema or database. This Yes All Schema” option allows you to define that. “onDelete” If the foreign record is removed, perform this action on the local Yes MySQL record(s). PostgreSQL “onUpdate” If the foreign record is updated, perform this action on the local Yes MySQL record(s). PostgreSQL
Writing Migrations
Migrations aren’t only designed to “morph” table. A migration is just a regular PHP class so you’re not limited to these functions. For example after adding a column you could write code to set the value of that column for existing records. For more details and examples of individual methods, check the database component.
use Phalcon\Mvc\Model\Migration;
class ProductsMigration_100 extends Migration { public function up() { // ...
Depending on how outdated is the database with respect to migrations, Phalcon may run multiple migration versions in the same migration process. If you specify a target version, Phalcon will run the required migrations until it reaches the specified version.
Mendebug Aplikasi
PHP menawarkan tool untuk mendebug aplikasi menggunakan pesan pemberitahuan, peringatan, kesalahan dan ek- sepsi. Kelas Exception menawarkan informasi seperti file, baris, pesan, kode numerik, backtrace dan lain-lain. dimana error terjadi. Framework OOP seperti Phalcon utamanya menggunakan kelas ini untuk membungkus fungsionalitas ini dan menyediakan informasi tersebut ke developer atau pengguna. Meski ditulis dalam C, Phalcon menjalankan metode di ranah PHP, menyediakan kapabilitas debug yang dimiliki aplikasi atau framework lain yang ditulis dengan PHP.
Menangkap Eksepsi
Sepanjang tutorial dan contoh dokumentasi Phalcon, ada elemen umum yang menangkap eksepsi. Ini adalah blok try/catch:
Tiap eksepsi yang dilempar dalam blok ini akan ditangkap dalam variabel $e. Phalcon\Exception diturunkan dari Kelas Exception PHP dan digunakan untuk memahami apakah eksepsi berasal dari Phalcon atau PHP. Semua eksepsi dibangkitkan oleh PHP barasal dari kelas Exception, dan paling tidak punya elemen berikut:
/* Properties */ protected string $message; protected int $code; protected string $file; protected int $line;
/* Methods */ public __construct ([ string $message="" [, int $code=0 [, Exception
˓→$previous= NULL ]]]) final public string getMessage ( void ) final public Exception getPrevious ( void ) final public mixed getCode ( void ) final public string getFile ( void ) final public int getLine ( void ) final public array getTrace ( void ) final public string getTraceAsString ( void ) public string __toString ( void ) final private void __clone ( void ) }
Mengambil informasi dari Phalcon\Exception sama dengan kelas Exception PHP:
Anda dapat lihat dari output diatas kelas dan metode Phalcon ditampilkan seperti halnya komponen lain, dan bahkan menampilkan parameter yang digunakan dalam tiap pemanggilan. Method Exception::getTrace menyediakan infor- masi tambahan bila diperlukan.
Komponen Debug
Phalcon menyediakan sebuah komponen debug yang memungkinkan developer dengan mudah menemukan error yang dihasilkan aplikasi yang dibuat dengan framework ini. Screencast berikut ini menjelaskan bagaimana ia bekerja: Untuk menghidupkannya, tambahkan kode berikut ini di bootstrap anda:
$debug= new \Phalcon\Debug(); $debug->listen();
Tiap blok Try/Catch harus dihapus atau dimatikan agar komponen ini bekerja semestinya.
Refleksi dan Introspeksi
Tiap instance kelas Phalcon menawarkan perilaku yang sama seperti kelas PHP biasa. Dimungkinkan untuk menggu- nakan Reflection API atau print sembarang objek untuk menunjukkan status internalnya:
$router= new Phalcon\Mvc\Router(); print_r($router);
Mudah untuk mengetahu status internal tiap objek. Contoh di atas mencetak berikut:
XDebug adalah tool yang keren yang melengkapi debugging aplikasi PHP. Ia juga adalah ektensi C untuk PHP, dan anda dapat menggunakannya bersama Phalcon tanpa konfigurasi tambahan atau efek samping. Screencast berikut menunjukkan sesi Xdebug dengan Phalcon: Setelah anda menginstall xdebug, anda dapat menggunakan API-nya untuk mendapatkan informasi lebih detail men- genai eksepsi dan pesan. Kami sarankan menggunakan paling tidak XDebug 2.2.3 untuk kompatibilitas lebih baik dengan Phalcon
Contoh berikut mengimplementasi xdebug_print_function_stack untuk menghentikan eksekusi dan menghasilkan backtrace:
}
public function registerAction() { // Request variabel dari form HTML $name= $this->request->getPost("name","string"); $email= $this->request->getPost("email","email");
// Stop eksekusi dan tunjukkan backtrace return xdebug_print_function_stack("stop here!");
$user= new Users(); $user->name= $name; $user->email= $email;
// Store and check for errors $user->save(); } }
Di sini, Xdebug juga akan menunjukkan variabel di lingkup lokal dan backtrace nya juga:
Xdebug: stop here! in /Applications/MAMP/htdocs/tutorial/app/controllers/
Xdebug menyediakan beberapa cara untuk mendapatkan informasi debug dan trace terkait eksekusi aplikasi menggu- nakan Phalcon. Anda dapt membaca dokumentasi XDebug untuk informasi lanjut.
Unit testing
Writing proper tests can assist in writing better software. If you set up proper test cases you can eliminate most functional bugs and better maintain your software.
If you don’t already have phpunit installed, you can do it by using the following composer command:
composer require phpunit/phpunit:^5.0
or by manually adding it to composer.json:
{ "require-dev":{ "phpunit/phpunit": "^5.0" } }
Once phpunit is installed create a directory called ‘tests’ in your root directory:
app/ public/ tests/
Next, we need a ‘helper’ file to bootstrap the application for unit testing.
The PHPunit helper file
A helper file is required to bootstrap the application for running the tests. We have prepared a sample file. Put the file in your tests/ directory as TestHelper.php.
use Phalcon\Di; use Phalcon\Di\FactoryDefault; use Phalcon\Loader;
Should you need to test any components from your own library, add them to the autoloader or use the autoloader from your main application. To help you build the unit tests, we made a few abstract classes you can use to bootstrap the unit tests themselves. These files exist in the Phalcon incubator @ https://github.com/phalcon/incubator. You can use the incubator library by adding it as a dependency: composer require phalcon/incubator or by manually adding it to composer.json:
{ "require":{ "phalcon/incubator": "^3.0" } }
You can also clone the repository using the repo link above.
PHPunit.xml file
Now, create a phpunit file:
./
Modify the phpunit.xml to fit your needs and save it in tests/. This will run any tests under the tests/ directory.
Sample unit test
To run any unit tests you need to define them. The autoloader will make sure the proper files are loaded so all you need to do is create the files and phpunit will run the tests for you.
This example does not contain a config file, most test cases however, do need one. You can add it to the DI to get the UnitTestCase file. First create a base unit test called UnitTestCase.php in your /tests directory:
public function setUp() { parent::setUp();
// Load any additional services that might be required during testing $di= Di::getDefault();
// Get any DI components here. If you have a config, be sure to pass it to
˓→the parent
$this->setDi($di);
$this->_loaded= true; }
/** * Check if the test case is setup properly * * @throws \PHPUnit_Framework_IncompleteTestError; */ public function __destruct() { if (!$this->_loaded){ throw new \PHPUnit_Framework_IncompleteTestError( "Please run parent::setUp()." ); } } }
It’s always a good idea to separate your Unit tests in namespaces. For this test we will create the namespace ‘Test’. So create a file called testsTestUnitTest.php:
class UnitTest extends \UnitTestCase { public function testTestCase() { $this->assertEquals( "works", "works", "This is OK" );
$this->assertEquals( "works", "works1", "This will fail" ); } }
Now when you execute ‘phpunit’ in your command-line from the tests directory you will get the following output:
$ phpunit PHPUnit3.7.23 by Sebastian Bergmann.
Configuration read from /private/var/www/tests/phpunit.xml
Time:3 ms, Memory:3.25Mb
There was1 failure:
1) Test\UnitTest::testTestCase This will fail Failed asserting that two strings are equal. --- Expected +++ Actual @@ @@ -'works' +'works1'
/private/var/www/tests/Test/UnitTest.php:25
FAILURES! Tests:1, Assertions:2, Failures:1.
Now you can start building your unit tests. You can view a good guide here (we also recommend reading the PHPunit documentation if you’re not familiar with PHPunit): http://blog.stevensanderson.com/2009/08/24/writing-great-unit-tests-best-and-worst-practises/
In Depth Explanations / Further Reading
Increasing Performance: What’s next?
Get faster applications requires refine many aspects: server, client, network, database, web server, static sources, etc. In this chapter we highlight scenarios where you can improve performance and how detect what is really slow in your application.
Each application is different, the permanent profiling is important to understand where performance can be increased. Profiling gives us a real picture on what is really slow and what does not. Profiles can vary between a request and another, so it is important to make enough measurements to make conclusions.
Profiling with XDebug
Xdebug provides an easier way to profile PHP applications, just install the extension and enable profiling in the php.ini: xdebug.profiler_enable= On
Using a tool like Webgrind you can see which functions/methods are slower than others:
Profiling with Xhprof
Xhprof is another interesting extension to profile PHP applications. Add the following line to the start of the bootstrap file:
Then at the end of the file save the profiled data:
$xhprof_data= xhprof_disable('/tmp');
2.4. In Depth Explanations / Further Reading 497 Phalcon PHP Framework Documentation, Release 3.1.1
$xhprof_runs= new XHProfRuns_Default(); $run_id= $xhprof_runs->save_run($xhprof_data,"xhprof_testing"); echo "http://localhost/xhprof/xhprof_html/index.php?run={$run_id}&source=xhprof_
˓→testing\n";
Xhprof provides a built-in HTML viewer to analyze the profiled data:
Profiling SQL Statements
Most database systems provide tools to identify slow SQL statements. Detecting and fixing slow queries is very important in order to increase performance in the server side. In the Mysql case, you can use the slow query log to know what SQL queries are taking more time than expected: log-slow-queries= /var/log/slow-queries.log long_query_time= 1.5
Profile on the Client
Sometimes we may need to improve the loading of static elements such as images, javascript and css to improve performance. The following tools are useful to detect common bottlenecks in the client side:
Most modern browsers have tools to profile the page loading time. In Chrome you can use the web inspector to know how much time is taking the loading of the different resources required by a single page: Firebug provides a similar functionality:
Yahoo! YSlow
YSlow analyzes web pages and suggests ways to improve their performance based on a set of rules for high perfor- mance web pages
Profile with Speed Tracer
Speed Tracer is a tool to help you identify and fix performance problems in your web applications. It visualizes metrics that are taken from low level instrumentation points inside of the browser and analyzes them as your application runs. Speed Tracer is available as a Chrome extension and works on all platforms where extensions are currently supported (Windows and Linux). This tool is very useful because it help you to get the real time used to render the whole page including HTML parsing, Javascript evaluation and CSS styling.
Use a recent PHP version
PHP is faster every day, using the latest version improves the performance of your applications and also of Phalcon.
2.4. In Depth Explanations / Further Reading 499 Phalcon PHP Framework Documentation, Release 3.1.1
2.4. In Depth Explanations / Further Reading 503 Phalcon PHP Framework Documentation, Release 3.1.1
Use a PHP Bytecode Cache
APC as many other bytecode caches help an application to reduce the overhead of read, tokenize and parse PHP files in each request. Once the extension is installed use the following setting to enable APC: apc.enabled= On
PHP 5.5 includes a built-in bytecode cache called ZendOptimizer+, this extension is also available for 5.3 and 5.4.
Do blocking work in the background
Process a video, send e-mails, compress a file or an image, etc., are slow tasks that must be processed in background jobs. There are a variety of tools that provide queuing or messaging systems that work well with PHP: • Beanstalkd • Redis • RabbitMQ • Resque • Gearman • ZeroMQ
Google Page Speed mod_pagespeed speeds up your site and reduces page load time. This open-source Apache HTTP server module (also available for nginx as ngx_pagespeed) automatically applies web performance best practices to pages, and associated assets (CSS, JavaScript, images) without requiring that you modify your existing content or workflow.
Dependency Injection Explained
Contoh berikut ini agak panjang, namun ia mencoba menjelaskan mengapa Phalcon menggunakan lokasi service (service location) dan injeksi ketergantungan (dependency injection). Pertama, anggap kita mengembangkan sebuah komponen bernama SomeComponent. Ia mengerjakan tugas yang saat ini tidak penting. Komponen kita punya keter- gantungan yakni koneksi ke sebuah database. Di contoh pertama, koneksi diciptakan dalam komponen. Pendekatan ini tidak praktis; karena kita tidak dapat meng- ganti parameter koneksi atau tipe sistem database karena komponen ini hanya bekerja saat diciptakan.
Untuk memecahkan ini, kita menciptakan setter yang menginjeksi ketergantungan dari luar sebelum menggunakan. Untuk sekarang, ini sepertinya solusi bagus:
/** * Set koneksi dari eksternal */ public function setConnection($connection) { $this->_connection= $connection; }
public function someDbTask() { $connection= $this->_connection;
// ... } }
$some= new SomeComponent();
// Buat koneksi $connection= new Connection( [ "host" =>"localhost", "username" =>"root", "password" =>"secret", "dbname" =>"invo", ] );
// Injeksi koneksi dalam komponen $some->setConnection($connection);
$some->someDbTask();
Sekarang anggap kita menggunakan komponen ini dalam bagian berbeda di aplikasi dan kita akan membutuhkan untuk menciptakan koneksi beberapa kali sebelum melewatkannya ke komponen. Menggunakan semacam registry global dimana kita memperoleh instance koneksi dan tidak perlu menciptakannya lagi dan lagi dapat memecahkan hal ini:
2.4. In Depth Explanations / Further Reading 505 Phalcon PHP Framework Documentation, Release 3.1.1
/** * Set koneksi dari ekternal */ public function setConnection($connection) { $this->_connection= $connection; }
public function someDbTask() { $connection= $this->_connection;
// ... } }
$some= new SomeComponent();
// Lewatkan koneksi yang terdefinisi dalam registry $some->setConnection(Registry::getConnection());
$some->someDbTask();
Sekarang, bayangkan kita harus mengimplementasi dua metode dalam komponen, yang pertama selalu butuh mencip- takan koneksi baru dan yang kedua selalu perlu menggunakan koneksi berbagi:
/** * Buat koneksi sekali dan kembalikan */ public static function getSharedConnection() { if (self::$_connection === null){ self::$_connection= self::_createConnection(); }
return self::$_connection; }
/** * Selalu kembalikan koneksi baru */ public static function getNewConnection() { return self::_createConnection(); } } class SomeComponent { protected $_connection;
/** * Set koneksi dari luar */ public function setConnection($connection) { $this->_connection= $connection; }
/** * Metode ini butuh koneksi berbagi */ public function someDbTask() { $connection= $this->_connection;
// ... }
/** * metode ini selalu butuh koneksi baru
2.4. In Depth Explanations / Further Reading 507 Phalcon PHP Framework Documentation, Release 3.1.1
// Lewatkan koneksi baru $some->someOtherDbTask( Registry::getNewConnection() );
Sejauh ini kita telah melihat bagaimana dependency injection memecahkan masalah kita. Melewatkan ketergantungan sebagai argumen daripada menciptakannya secara internal dalam kode membuat aplikasi kita lebih mudah dikelola dan terpisah (decoupled). Namun, di jangka panjang, bentuk injeksi ketergantungan ini punya kekurangan. Contoh, jika komponen punya banyak ketergantungan, kita akan butuh menciptakan banyak argumen setter untuk melewatkan ketergantungan atau menciptakan sebuah kontruktor yang melewatkannya dalam banyak argumen, di- tambah lagi menciptakan ketergantungan sebelum menggunakan komponen, setiap kali, menjadikan kode kita tidak mudah dikelola seperti yang kita mau:
// Buat ketergantungan atau ambil dari registry $connection= new Connection(); $session= new Session(); $fileSystem= new FileSystem(); $filter= new Filter(); $selector= new Selector();
// Lewatkan sebagai parameter konstruktor $some= new SomeComponent($connection, $session, $fileSystem, $filter, $selector);
// ... atau menggunakan setter $some->setConnection($connection); $some->setSession($session); $some->setFileSystem($fileSystem); $some->setFilter($filter); $some->setSelector($selector);
Bayangkan bila kita harus menciptakan objek ini di banyak bagian aplikasi kita. Di masa datang, jika kita tidak lagi butuh ketergantungan, kita butuh menjelajahi semua kode untuk menghapus parameter di tiap kontruktor atau setter dimana kita injeksi kode. Untuk memecahkan hal ini, kita kembali ke registry global untuk menciptakan komponen. Namun, ia menambah lapisan abstraksi baru sebelum menciptakan objek:
/** * Buat metode factory untuk menciptakan instance SomeComponent dan menginjeksi ˓→ketergantungan */ public static function factory() { $connection= new Connection(); $session= new Session(); $fileSystem= new FileSystem(); $filter= new Filter(); $selector= new Selector();
return new self($connection, $session, $fileSystem, $filter, $selector); } }
Sekarang kita kembali ka awal, kita kembali membuat ketergantungan dalam komponen! Kita harus menemukan solusi yang menghindarkan kita dari praktek buruk. Cara praktis dan elegan untuk menyelesaikan masalah ini adalah menggunakan sebuah kontainer untuk ketergan- tungan. Kontainer bertindak sebagai registry global yang kita lihat sebelumnya. Menggunakan kontainer sebagai jembatan untuk memperoleh ketergantungan memungkinkan kita menurunkan kompleksitas komponen kita:
public function __construct(DiInterface $di) { $this->_di= $di; }
public function someDbTask() { // Ambil service koneksi // selalu kembalikan koneksi baru $connection= $this->_di->get("db"); }
public function someOtherDbTask() { // ambil koneksi berbagi // ini akan selalu mengembalikan koneksi yang sama $connection= $this->_di->getShared("db");
// This method also requires an input filtering service $filter= $this->_di->get("filter"); } }
$di= new Di();
2.4. In Depth Explanations / Further Reading 509 Phalcon PHP Framework Documentation, Release 3.1.1
// Daftarkan service "db" dalam kontainer $di->set( "db", function () { return new Connection( [ "host" =>"localhost", "username" =>"root", "password" =>"secret", "dbname" =>"invo", ] ); } );
// Daftarkan service "filter" dalam kontainer $di->set( "filter", function () { return new Filter(); } );
// Daftarkan service "session" dalam kontainer $di->set( "session", function () { return new Session(); } );
// Lewatkan kontainer service ke komponen $some= new SomeComponent($di);
$some->someDbTask();
Komponen sekarang dapat dengan mudah mengakses service yang diperlukan ketika membutuhkannya, bila tidak dibutuhkan ia tidak akan menginisialisasi service tersebut, sehingga menghemat resource. Komponen saat ini terpisah (highly decoupled). Contoh, kita dapat mengganti cara bagaimana koneksi dibuat, perilakunya atau aspek lain darinya dan tidak akan berpengaruh ke komponen.
Understanding How Phalcon Applications Work
Jika anda mengikuti tutorial atau membuat kode menggunakan Phalcon Devtools, anda mungkin mengenali file boot- strap berikut:
$dispatcher->setParams( $router->getParams() ); try { // Kirim request $dispatcher->dispatch(); } catch (Exception $e){ // An exception has occurred, dispatch some controller/action aimed for that
// Lewatkan parameter router yang telah diproses ke dispatcher $dispatcher->setControllerName("errors"); $dispatcher->setActionName("action503");
// Kirim request $dispatcher->dispatch(); }
// Get the returned value by the last executed action $response= $dispatcher->getReturnedValue();
// Check if the action returned is a 'response' object if ($response instanceof ResponseInterface) { // Send the response $response->send(); }
Meski implementasi di atas lebih banyak kodenya dibanding menggunakan Phalcon\Mvc\Application, ia menawarkan alternatif bootstraping aplikasi anda. Tergantung kebutuhan anda, anda mungkin ingin memiliki kendali penuh ter- hadap apa yang harus diciptakan dan yang tidak, atau mengganti komponen tertentu dengan milik anda sendiri untuk memperluas fungsionalitas defaultnya.
2.4. In Depth Explanations / Further Reading 513 Phalcon PHP Framework Documentation, Release 3.1.1
API
API Indice
Abstract class Phalcon\Acl
Constants
integer ALLOW integer DENY
Abstract class Phalcon\Acl\Adapter
implements Phalcon\Acl\AdapterInterface, Phalcon\Events\EventsAwareInterface Adapter for Phalcon\Acl adapters
Methods
public getActiveRole () Role which the list is checking if it’s allowed to certain resource/access public getActiveResource () Resource which the list is checking if some role can access it public getActiveAccess () Active access which the list is checking if some role can access it public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the events manager public getEventsManager () Returns the internal event manager public setDefaultAction (mixed $defaultAccess) Sets the default access level (Phalcon\Acl::ALLOW or Phalcon\Acl::DENY) public getDefaultAction () Returns the default ACL access level abstract public setNoArgumentsDefaultAction (mixed $defaultAccess) inherited from Phalcon\Acl\AdapterInterface ... abstract public getNoArgumentsDefaultAction () inherited from Phalcon\Acl\AdapterInterface ... abstract public addRole (mixed $role, [mixed $accessInherits]) inherited from Phalcon\Acl\AdapterInterface ... abstract public addInherit (mixed $roleName, mixed $roleToInherit) inherited from Phalcon\Acl\AdapterInterface
... abstract public isRole (mixed $roleName) inherited from Phalcon\Acl\AdapterInterface ... abstract public isResource (mixed $resourceName) inherited from Phalcon\Acl\AdapterInterface ... abstract public addResource (mixed $resourceObject, mixed $accessList) inherited from Phal- con\Acl\AdapterInterface ... abstract public addResourceAccess (mixed $resourceName, mixed $accessList) inherited from Phal- con\Acl\AdapterInterface ... abstract public dropResourceAccess (mixed $resourceName, mixed $accessList) inherited from Phal- con\Acl\AdapterInterface ... abstract public allow (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) inherited from Phal- con\Acl\AdapterInterface ... abstract public deny (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) inherited from Phal- con\Acl\AdapterInterface ... abstract public isAllowed (mixed $roleName, mixed $resourceName, mixed $access, [array $parameters]) inherited from Phalcon\Acl\AdapterInterface ... abstract public getRoles () inherited from Phalcon\Acl\AdapterInterface ... abstract public getResources () inherited from Phalcon\Acl\AdapterInterface ...
Class Phalcon\Acl\Adapter\Memory extends abstract class Phalcon\Acl\Adapter implements Phalcon\Events\EventsAwareInterface, Phalcon\Acl\AdapterInterface Manages ACL lists in memory
$acl= new \Phalcon\Acl\Adapter\Memory();
$acl->setDefaultAction( \Phalcon\Acl::DENY );
// Register roles
2.5. API 515 Phalcon PHP Framework Documentation, Release 3.1.1
$roles=[ "users" => new \Phalcon\Acl\Role("Users"), "guests" => new \Phalcon\Acl\Role("Guests"), ]; foreach ($roles as $role){ $acl->addRole($role); }
// Private area resources $privateResources=[ "companies" =>["index","search","new","edit","save","create","delete"], "products" =>["index","search","new","edit","save","create","delete"], "invoices" =>["index","profile"], ]; foreach ($privateResources as $resourceName => $actions){ $acl->addResource( new \Phalcon\Acl\Resource($resourceName), $actions ); }
// Public area resources $publicResources=[ "index" =>["index"], "about" =>["index"], "session" =>["index","register","start","end"], "contact" =>["index","send"], ]; foreach ($publicResources as $resourceName => $actions){ $acl->addResource( new \Phalcon\Acl\Resource($resourceName), $actions ); }
// Grant access to public areas to both users and guests foreach ($roles as $role){ foreach ($publicResources as $resource => $actions){ $acl->allow($role->getName(), $resource," *"); } }
// Grant access to private area to role Users foreach ($privateResources as $resource => $actions){ foreach ($actions as $action){ $acl->allow("Users", $resource, $action); } }
Methods public __construct () Phalcon\Acl\Adapter\Memory constructor
516 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public addRole (RoleInterface | string $role, [array | string $accessInherits]) Adds a role to the ACL list. Second parameter allows inheriting access data from other existing role Example:
$acl->addRole( new Phalcon\Acl\Role("administrator"), "consultant" );
$acl->addRole("administrator","consultant"); public addInherit (mixed $roleName, mixed $roleToInherit) Do a role inherit from another existing role public isRole (mixed $roleName) Check whether role exist in the roles list public isResource (mixed $resourceName) Check whether resource exist in the resources list public addResource (Phalcon\Acl\Resource | string $resourceValue, array | string $accessList) Adds a resource to the ACL list Access names can be a particular action, by example search, update, delete, etc or a list of them Example:
// Add a resource to the the list allowing access to an action $acl->addResource( new Phalcon\Acl\Resource("customers"), "search" );
$acl->addResource("customers","search");
// Add a resource with an access list $acl->addResource( new Phalcon\Acl\Resource("customers"), [ "create", "search", ] );
$acl->addResource( "customers", [ "create", "search", ] ); public addResourceAccess (mixed $resourceName, array | string $accessList) Adds access to resources public dropResourceAccess (mixed $resourceName, array | string $accessList)
2.5. API 517 Phalcon PHP Framework Documentation, Release 3.1.1
Removes an access from a resource protected _allowOrDeny (mixed $roleName, mixed $resourceName, mixed $access, mixed $action, [mixed $func]) Checks if a role has access to a resource public allow (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) Allow access to a role on a resource You can use ‘*’ as wildcard Example:
//Allow access to guests to search on customers $acl->allow("guests","customers","search");
//Allow access to guests to search or create on customers $acl->allow("guests","customers",["search","create"]);
//Allow access to any role to browse on products $acl->allow("*","products","browse");
//Allow access to any role to browse on any resource $acl->allow("*"," *","browse"); public deny (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) Deny access to a role on a resource You can use ‘*’ as wildcard Example:
//Deny access to guests to search on customers $acl->deny("guests","customers","search");
//Deny access to guests to search or create on customers $acl->deny("guests","customers",["search","create"]);
//Deny access to any role to browse on products $acl->deny("*","products","browse");
//Deny access to any role to browse on any resource $acl->deny("*"," *","browse"); public isAllowed (RoleInterface | RoleAware | string $roleName, ResourceInterface | ResourceAware | string $re- sourceName, mixed $access, [array $parameters]) Check whether a role is allowed to access an action from a resource
//Does andres have access to the customers resource to create? $acl->isAllowed("andres","Products","create");
//Do guests have access to any resource to edit? $acl->isAllowed("guests"," *","edit"); public setNoArgumentsDefaultAction (mixed $defaultAccess) Sets the default access level (Phalcon\Acl::ALLOW or Phalcon\Acl::DENY) for no arguments provided in isAllowed action if there exists func for accessKey public getNoArgumentsDefaultAction ()
Returns the default ACL access level for no arguments provided in isAllowed action if there exists func for accessKey public getRoles () Return an array with every role registered in the list public getResources () Return an array with every resource registered in the list public getActiveRole () inherited from Phalcon\Acl\Adapter Role which the list is checking if it’s allowed to certain resource/access public getActiveResource () inherited from Phalcon\Acl\Adapter Resource which the list is checking if some role can access it public getActiveAccess () inherited from Phalcon\Acl\Adapter Active access which the list is checking if some role can access it public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Acl\Adapter Sets the events manager public getEventsManager () inherited from Phalcon\Acl\Adapter Returns the internal event manager public setDefaultAction (mixed $defaultAccess) inherited from Phalcon\Acl\Adapter Sets the default access level (Phalcon\Acl::ALLOW or Phalcon\Acl::DENY) public getDefaultAction () inherited from Phalcon\Acl\Adapter Returns the default ACL access level
Class Phalcon\Acl\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception
2.5. API 519 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Acl\Resource
implements Phalcon\Acl\ResourceInterface This class defines resource entity and its description
Methods
public getName () Resource name public __toString () Resource name public getDescription () Resource description public __construct (mixed $name, [mixed $description]) Phalcon\Acl\Resource constructor
Class Phalcon\Acl\Role
implements Phalcon\Acl\RoleInterface This class defines role entity and its description
Methods
public getName () Role name public __toString () Role name
public getDescription () Role description public __construct (mixed $name, [mixed $description]) Phalcon\Acl\Role constructor
Abstract class Phalcon\Annotations\Adapter
implements Phalcon\Annotations\AdapterInterface This is the base class for Phalcon\Annotations adapters
Methods
public setReader (Phalcon\Annotations\ReaderInterface $reader) Sets the annotations parser public getReader () Returns the annotation reader public get (string | object $className) Parses or retrieves all the annotations found in a class public getMethods (mixed $className) Returns the annotations found in all the class’ methods public getMethod (mixed $className, mixed $methodName) Returns the annotations found in a specific method public getProperties (mixed $className) Returns the annotations found in all the class’ methods public getProperty (mixed $className, mixed $propertyName) Returns the annotations found in a specific property
Class Phalcon\Annotations\Adapter\Apc
extends abstract class Phalcon\Annotations\Adapter implements Phalcon\Annotations\AdapterInterface Stores the parsed annotations in APC. This adapter is suitable for production
use Phalcon\Annotations\Adapter\Apc;
$annotations= new Apc();
2.5. API 521 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct ([array $options]) Phalcon\Annotations\Adapter\Apc constructor public read (mixed $key) Reads parsed annotations from APC public write (mixed $key, Phalcon\Annotations\Reflection $data) Writes parsed annotations to APC public setReader (Phalcon\Annotations\ReaderInterface $reader) inherited from Phalcon\Annotations\Adapter Sets the annotations parser public getReader () inherited from Phalcon\Annotations\Adapter Returns the annotation reader public get (string | object $className) inherited from Phalcon\Annotations\Adapter Parses or retrieves all the annotations found in a class public getMethods (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getMethod (mixed $className, mixed $methodName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific method public getProperties (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getProperty (mixed $className, mixed $propertyName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific property
Class Phalcon\Annotations\Adapter\Files extends abstract class Phalcon\Annotations\Adapter implements Phalcon\Annotations\AdapterInterface Stores the parsed annotations in files. This adapter is suitable for production
$annotations= new Files( [ "annotationsDir" =>"app/cache/annotations/", ] );
public __construct ([array $options]) Phalcon\Annotations\Adapter\Files constructor public Phalcon\Annotations\Reflection read (string $key) Reads parsed annotations from files public write (mixed $key, Phalcon\Annotations\Reflection $data) Writes parsed annotations to files public setReader (Phalcon\Annotations\ReaderInterface $reader) inherited from Phalcon\Annotations\Adapter Sets the annotations parser public getReader () inherited from Phalcon\Annotations\Adapter Returns the annotation reader public get (string | object $className) inherited from Phalcon\Annotations\Adapter Parses or retrieves all the annotations found in a class public getMethods (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getMethod (mixed $className, mixed $methodName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific method public getProperties (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getProperty (mixed $className, mixed $propertyName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific property
Class Phalcon\Annotations\Adapter\Memory
extends abstract class Phalcon\Annotations\Adapter implements Phalcon\Annotations\AdapterInterface Stores the parsed annotations in memory. This adapter is the suitable development/testing
Methods
public read (mixed $key) Reads parsed annotations from memory public write (mixed $key, Phalcon\Annotations\Reflection $data) Writes parsed annotations to memory public setReader (Phalcon\Annotations\ReaderInterface $reader) inherited from Phalcon\Annotations\Adapter Sets the annotations parser public getReader () inherited from Phalcon\Annotations\Adapter
2.5. API 523 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the annotation reader public get (string | object $className) inherited from Phalcon\Annotations\Adapter Parses or retrieves all the annotations found in a class public getMethods (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getMethod (mixed $className, mixed $methodName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific method public getProperties (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getProperty (mixed $className, mixed $propertyName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific property
Class Phalcon\Annotations\Adapter\Xcache
extends abstract class Phalcon\Annotations\Adapter implements Phalcon\Annotations\AdapterInterface Stores the parsed annotations to XCache. This adapter is suitable for production
$annotations= new \Phalcon\Annotations\Adapter\Xcache();
Methods
public Phalcon\Annotations\Reflection read (string $key) Reads parsed annotations from XCache public write (mixed $key, Phalcon\Annotations\Reflection $data) Writes parsed annotations to XCache public setReader (Phalcon\Annotations\ReaderInterface $reader) inherited from Phalcon\Annotations\Adapter Sets the annotations parser public getReader () inherited from Phalcon\Annotations\Adapter Returns the annotation reader public get (string | object $className) inherited from Phalcon\Annotations\Adapter Parses or retrieves all the annotations found in a class public getMethods (mixed $className) inherited from Phalcon\Annotations\Adapter Returns the annotations found in all the class’ methods public getMethod (mixed $className, mixed $methodName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific method public getProperties (mixed $className) inherited from Phalcon\Annotations\Adapter
Returns the annotations found in all the class’ methods public getProperty (mixed $className, mixed $propertyName) inherited from Phalcon\Annotations\Adapter Returns the annotations found in a specific property
Class Phalcon\Annotations\Annotation
Represents a single annotation in an annotations collection
Methods public __construct (array $reflectionData) Phalcon\Annotations\Annotation constructor public getName () Returns the annotation’s name public mixed getExpression (array $expr) Resolves an annotation expression public array getExprArguments () Returns the expression arguments without resolving public array getArguments () Returns the expression arguments public numberArguments () Returns the number of arguments that the annotation has public mixed getArgument (int | string $position) Returns an argument in a specific position public boolean hasArgument (int | string $position) Returns an argument in a specific position public mixed getNamedArgument (mixed $name) Returns a named argument public mixed getNamedParameter (mixed $name) Returns a named parameter
Class Phalcon\Annotations\Collection implements Iterator, Traversable, Countable Represents a collection of annotations. This class allows to traverse a group of annotations easily
//Traverse annotations foreach ($classAnnotations as $annotation){ echo "Name=", $annotation->getName(), PHP_EOL;
2.5. API 525 Phalcon PHP Framework Documentation, Release 3.1.1
}
//Check if the annotations has a specific var_dump($classAnnotations->has("Cacheable"));
//Get an specific annotation in the collection $annotation= $classAnnotations->get("Cacheable");
Methods
public __construct ([array $reflectionData]) Phalcon\Annotations\Collection constructor public count () Returns the number of annotations in the collection public rewind () Rewinds the internal iterator public Phalcon\Annotations\Annotation current () Returns the current annotation in the iterator public key () Returns the current position/key in the iterator public next () Moves the internal iteration pointer to the next position public valid () Check if the current annotation in the iterator is valid public getAnnotations () Returns the internal annotations as an array public get (mixed $name) Returns the first annotation that match a name public getAll (mixed $name) Returns all the annotations that match a name public has (mixed $name) Check if an annotation exists in a collection
Class Phalcon\Annotations\Exception extends class Exception implements Throwable
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Annotations\Reader implements Phalcon\Annotations\ReaderInterface Parses docblocks returning an array with the found annotations
Methods public parse (mixed $className) Reads annotations from the class dockblocks, its methods and/or properties public static parseDocBlock (mixed $docBlock, [mixed $file], [mixed $line]) Parses a raw doc block returning the annotations found
2.5. API 527 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Annotations\Reflection
Allows to manipulate the annotations reflection in an OO manner
// Parse the annotations in a class $reader= new Reader(); $parsing= $reader->parse("MyComponent");
// Create the reflection $reflection= new Reflection($parsing);
// Get the annotations in the class docblock $classAnnotations= $reflection->getClassAnnotations();
Methods public __construct ([array $reflectionData]) Phalcon\Annotations\Reflection constructor public getClassAnnotations () Returns the annotations found in the class docblock public getMethodsAnnotations () Returns the annotations found in the methods’ docblocks public getPropertiesAnnotations () Returns the annotations found in the properties’ docblocks public array getReflectionData () Returns the raw parsing intermediate definitions used to construct the reflection public static array data __set_state (mixed $data) Restores the state of a Phalcon\Annotations\Reflection variable export
Abstract class Phalcon\Application extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface Base class for Phalcon\Cli\Console and Phalcon\Mvc\Application.
Methods public __construct ([Phalcon\DiInterface $dependencyInjector]) public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the events manager
public getEventsManager () Returns the internal event manager public registerModules (array $modules, [mixed $merge]) Register an array of modules present in the application
public getModules () Return the modules registered in the application public getModule (mixed $name) Gets the module definition registered in the application via module name public setDefaultModule (mixed $defaultModule) Sets the module name to be used if the router doesn’t return a valid module public getDefaultModule () Returns the default module name abstract public handle () Handles a request public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Application\Exception
extends class Phalcon\Exception implements Throwable
2.5. API 529 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Assets\Collection
implements Countable, Iterator, Traversable Represents a collection of resources
Methods public getPrefix () ... public getLocal () ... public getResources () ...
public getCodes () ... public getPosition () ... public getFilters () ... public getAttributes () ... public getJoin () ... public getTargetUri () ... public getTargetPath () ... public getTargetLocal () ... public getSourcePath () ... public add (Phalcon\Assets\Resource $resource) Adds a resource to the collection public addInline (Phalcon\Assets\Inline $code) Adds an inline code to the collection public addCss (mixed $path, [mixed $local], [mixed $filter], [mixed $attributes]) Adds a CSS resource to the collection public addInlineCss (mixed $content, [mixed $filter], [mixed $attributes]) Adds an inline CSS to the collection public Phalcon\Assets\Collection addJs (string $path, [boolean $local], [boolean $filter], [array $attributes]) Adds a javascript resource to the collection public addInlineJs (mixed $content, [mixed $filter], [mixed $attributes]) Adds an inline javascript to the collection public count () Returns the number of elements in the form public rewind () Rewinds the internal iterator public current () Returns the current resource in the iterator
2.5. API 531 Phalcon PHP Framework Documentation, Release 3.1.1 public int key () Returns the current position/key in the iterator public next () Moves the internal iteration pointer to the next position public valid () Check if the current element in the iterator is valid public setTargetPath (mixed $targetPath) Sets the target path of the file for the filtered/join output public setSourcePath (mixed $sourcePath) Sets a base source path for all the resources in this collection public setTargetUri (mixed $targetUri) Sets a target uri for the generated HTML public setPrefix (mixed $prefix) Sets a common prefix for all the resources public setLocal (mixed $local) Sets if the collection uses local resources by default public setAttributes (array $attributes) Sets extra HTML attributes public setFilters (array $filters) Sets an array of filters in the collection public setTargetLocal (mixed $targetLocal) Sets the target local public join (mixed $join) Sets if all filtered resources in the collection must be joined in a single result file public getRealTargetPath (mixed $basePath) Returns the complete location where the joined/filtered collection must be written public addFilter (Phalcon\Assets\FilterInterface $filter) Adds a filter to the collection
Class Phalcon\Assets\Exception extends class Phalcon\Exception implements Throwable
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Assets\Filters\Cssmin implements Phalcon\Assets\FilterInterface Minify the css - removes comments removes newlines and line feeds keeping removes last semicolon from last property
Methods public filter (mixed $content) Filters the content using CSSMIN
2.5. API 533 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Assets\Filters\Jsmin
implements Phalcon\Assets\FilterInterface Deletes the characters which are insignificant to JavaScript. Comments will be removed. Tabs will be replaced with spaces. Carriage returns will be replaced with linefeeds. Most spaces and linefeeds will be removed.
Methods
public filter (mixed $content) Filters the content using JSMIN
Class Phalcon\Assets\Filters\None
implements Phalcon\Assets\FilterInterface Returns the content without make any modification to the original source
Methods
public filter (mixed $content) Returns the content without be touched
Class Phalcon\Assets\Inline
Represents an inline asset
$inline= new \Phalcon\Assets\Inline("js","alert('hello world');");
Methods
public getType () ... public getContent () ... public getFilter () ... public getAttributes () ... public __construct (string $type, string $content, [boolean $filter], [array $attributes]) Phalcon\Assets\Inline constructor public setType (mixed $type)
Sets the inline’s type public setFilter (mixed $filter) Sets if the resource must be filtered or not public setAttributes (array $attributes) Sets extra HTML attributes
Class Phalcon\Assets\Inline\Css
extends class Phalcon\Assets\Inline Represents an inlined CSS
Methods
public __construct (string $content, [boolean $filter], [array $attributes]) public getType () inherited from Phalcon\Assets\Inline ... public getContent () inherited from Phalcon\Assets\Inline ... public getFilter () inherited from Phalcon\Assets\Inline ... public getAttributes () inherited from Phalcon\Assets\Inline ... public setType (mixed $type) inherited from Phalcon\Assets\Inline Sets the inline’s type public setFilter (mixed $filter) inherited from Phalcon\Assets\Inline Sets if the resource must be filtered or not public setAttributes (array $attributes) inherited from Phalcon\Assets\Inline Sets extra HTML attributes
Class Phalcon\Assets\Inline\Js extends class Phalcon\Assets\Inline Represents an inline Javascript
Methods public __construct (string $content, [boolean $filter], [array $attributes]) public getType () inherited from Phalcon\Assets\Inline ...
2.5. API 535 Phalcon PHP Framework Documentation, Release 3.1.1
public getContent () inherited from Phalcon\Assets\Inline ... public getFilter () inherited from Phalcon\Assets\Inline ... public getAttributes () inherited from Phalcon\Assets\Inline ... public setType (mixed $type) inherited from Phalcon\Assets\Inline Sets the inline’s type public setFilter (mixed $filter) inherited from Phalcon\Assets\Inline Sets if the resource must be filtered or not public setAttributes (array $attributes) inherited from Phalcon\Assets\Inline Sets extra HTML attributes
Class Phalcon\Assets\Manager
Manages collections of CSS/Javascript assets
Methods public __construct ([array $options]) public setOptions (array $options) Sets the manager options public getOptions () Returns the manager options public useImplicitOutput (mixed $implicitOutput) Sets if the HTML generated must be directly printed or returned public addCss (mixed $path, [mixed $local], [mixed $filter], [mixed $attributes]) Adds a Css resource to the ‘css’ collection
public addInlineCss (mixed $content, [mixed $filter], [mixed $attributes]) Adds an inline Css to the ‘css’ collection public addJs (mixed $path, [mixed $local], [mixed $filter], [mixed $attributes]) Adds a javascript resource to the ‘js’ collection
$assets->addJs("scripts/jquery.js"); $assets->addJs("http://jquery.my-cdn.com/jquery.js", false); public addInlineJs (mixed $content, [mixed $filter], [mixed $attributes]) Adds an inline javascript to the ‘js’ collection public addResourceByType (mixed $type, Phalcon\Assets\Resource $resource) Adds a resource by its type
$assets->addResourceByType("css", new \Phalcon\Assets\Resource\Css("css/style.css") ); public addInlineCodeByType (mixed $type, Phalcon\Assets\Inline $code) Adds an inline code by its type public addResource (Phalcon\Assets\Resource $resource) Adds a raw resource to the manager
$assets->addResource( new Phalcon\Assets\Resource("css","css/style.css") ); public addInlineCode (Phalcon\Assets\Inline $code) Adds a raw inline code to the manager public set (mixed $id, Phalcon\Assets\Collection $collection) Sets a collection in the Assets Manager
$assets->set("js", $collection); public get (mixed $id) Returns a collection by its id
$scripts= $assets->get("js"); public getCss () Returns the CSS collection of assets public getJs () Returns the CSS collection of assets public collection (mixed $name)
2.5. API 537 Phalcon PHP Framework Documentation, Release 3.1.1
Creates/Returns a collection of resources public output (Phalcon\Assets\Collection $collection, callback $callback, string $type) Traverses a collection calling the callback to generate its HTML public outputInline (Phalcon\Assets\Collection $collection, string $type) Traverses a collection and generate its HTML public outputCss ([string $collectionName]) Prints the HTML for CSS resources public outputInlineCss ([string $collectionName]) Prints the HTML for inline CSS public outputJs ([string $collectionName]) Prints the HTML for JS resources public outputInlineJs ([string $collectionName]) Prints the HTML for inline JS public getCollections () Returns existing collections in the manager public exists (mixed $id) Returns true or false if collection exists
Class Phalcon\Assets\Resource
Represents an asset resource
$resource= new \Phalcon\Assets\Resource("js","javascripts/jquery.js");
Methods
public getType () public getPath () public getLocal () public getFilter () public getAttributes () public getSourcePath () ... public getTargetPath () ... public getTargetUri () ...
538 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public __construct (string $type, string $path, [boolean $local], [boolean $filter], [array $attributes]) Phalcon\Assets\Resource constructor public setType (mixed $type) Sets the resource’s type public setPath (mixed $path) Sets the resource’s path public setLocal (mixed $local) Sets if the resource is local or external public setFilter (mixed $filter) Sets if the resource must be filtered or not public setAttributes (array $attributes) Sets extra HTML attributes public setTargetUri (mixed $targetUri) Sets a target uri for the generated HTML public setSourcePath (mixed $sourcePath) Sets the resource’s source path public setTargetPath (mixed $targetPath) Sets the resource’s target path public getContent ([mixed $basePath]) Returns the content of the resource as an string Optionally a base path where the resource is located can be set public getRealTargetUri () Returns the real target uri for the generated HTML public getRealSourcePath ([mixed $basePath]) Returns the complete location where the resource is located public getRealTargetPath ([mixed $basePath]) Returns the complete location where the resource must be written
Class Phalcon\Assets\Resource\Css extends class Phalcon\Assets\Resource Represents CSS resources
Methods public __construct (string $path, [boolean $local], [boolean $filter], [array $attributes]) public getType () inherited from Phalcon\Assets\Resource public getPath () inherited from Phalcon\Assets\Resource public getLocal () inherited from Phalcon\Assets\Resource
2.5. API 539 Phalcon PHP Framework Documentation, Release 3.1.1
public getFilter () inherited from Phalcon\Assets\Resource public getAttributes () inherited from Phalcon\Assets\Resource public getSourcePath () inherited from Phalcon\Assets\Resource ... public getTargetPath () inherited from Phalcon\Assets\Resource ... public getTargetUri () inherited from Phalcon\Assets\Resource ... public setType (mixed $type) inherited from Phalcon\Assets\Resource Sets the resource’s type public setPath (mixed $path) inherited from Phalcon\Assets\Resource Sets the resource’s path public setLocal (mixed $local) inherited from Phalcon\Assets\Resource Sets if the resource is local or external public setFilter (mixed $filter) inherited from Phalcon\Assets\Resource Sets if the resource must be filtered or not public setAttributes (array $attributes) inherited from Phalcon\Assets\Resource Sets extra HTML attributes public setTargetUri (mixed $targetUri) inherited from Phalcon\Assets\Resource Sets a target uri for the generated HTML public setSourcePath (mixed $sourcePath) inherited from Phalcon\Assets\Resource Sets the resource’s source path public setTargetPath (mixed $targetPath) inherited from Phalcon\Assets\Resource Sets the resource’s target path public getContent ([mixed $basePath]) inherited from Phalcon\Assets\Resource Returns the content of the resource as an string Optionally a base path where the resource is located can be set public getRealTargetUri () inherited from Phalcon\Assets\Resource Returns the real target uri for the generated HTML public getRealSourcePath ([mixed $basePath]) inherited from Phalcon\Assets\Resource Returns the complete location where the resource is located public getRealTargetPath ([mixed $basePath]) inherited from Phalcon\Assets\Resource Returns the complete location where the resource must be written
Class Phalcon\Assets\Resource\Js
extends class Phalcon\Assets\Resource Represents Javascript resources
public __construct (string $path, [boolean $local], [boolean $filter], [array $attributes]) public getType () inherited from Phalcon\Assets\Resource public getPath () inherited from Phalcon\Assets\Resource public getLocal () inherited from Phalcon\Assets\Resource public getFilter () inherited from Phalcon\Assets\Resource public getAttributes () inherited from Phalcon\Assets\Resource public getSourcePath () inherited from Phalcon\Assets\Resource ... public getTargetPath () inherited from Phalcon\Assets\Resource ... public getTargetUri () inherited from Phalcon\Assets\Resource ... public setType (mixed $type) inherited from Phalcon\Assets\Resource Sets the resource’s type public setPath (mixed $path) inherited from Phalcon\Assets\Resource Sets the resource’s path public setLocal (mixed $local) inherited from Phalcon\Assets\Resource Sets if the resource is local or external public setFilter (mixed $filter) inherited from Phalcon\Assets\Resource Sets if the resource must be filtered or not public setAttributes (array $attributes) inherited from Phalcon\Assets\Resource Sets extra HTML attributes public setTargetUri (mixed $targetUri) inherited from Phalcon\Assets\Resource Sets a target uri for the generated HTML public setSourcePath (mixed $sourcePath) inherited from Phalcon\Assets\Resource Sets the resource’s source path public setTargetPath (mixed $targetPath) inherited from Phalcon\Assets\Resource Sets the resource’s target path public getContent ([mixed $basePath]) inherited from Phalcon\Assets\Resource Returns the content of the resource as an string Optionally a base path where the resource is located can be set public getRealTargetUri () inherited from Phalcon\Assets\Resource Returns the real target uri for the generated HTML public getRealSourcePath ([mixed $basePath]) inherited from Phalcon\Assets\Resource Returns the complete location where the resource is located public getRealTargetPath ([mixed $basePath]) inherited from Phalcon\Assets\Resource
2.5. API 541 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the complete location where the resource must be written
Abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface This class implements common functionality for backend adapters. A backend cache adapter may extend this class
Methods public getFrontend () ... public setFrontend (mixed $frontend) ... public getOptions () ... public setOptions (mixed $options) ... public getLastKey () ... public setLastKey (mixed $lastKey) ... public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend constructor public mixed start (int | string $keyName, [int $lifetime]) Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) Stops the frontend without store any cached content public isFresh () Checks whether the last cache is fresh or cached public isStarted () Checks whether the cache has starting buffering or not public int getLifetime () Gets the last lifetime set abstract public get (mixed $keyName, [mixed $lifetime]) inherited from Phalcon\Cache\BackendInterface ... abstract public save ([mixed $keyName], [mixed $content], [mixed $lifetime], [mixed $stopBuffer]) inherited from Phalcon\Cache\BackendInterface ...
abstract public delete (mixed $keyName) inherited from Phalcon\Cache\BackendInterface ... abstract public queryKeys ([mixed $prefix]) inherited from Phalcon\Cache\BackendInterface ... abstract public exists ([mixed $keyName], [mixed $lifetime]) inherited from Phalcon\Cache\BackendInterface ...
Class Phalcon\Cache\Backend\Apc
extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data and raw data using an APC backend
use Phalcon\Cache\Backend\Apc; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data for 2 days $frontCache= new FrontData( [ "lifetime" => 172800, ] );
$cache= new Apc( $frontCache, [ "prefix" =>"app-data", ] );
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([string | int $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the APC backend and stops the frontend public increment ([string $keyName], [mixed $value]) Increment of a given key, by number $value public decrement ([string $keyName], [mixed $value])
2.5. API 543 Phalcon PHP Framework Documentation, Release 3.1.1
Decrement of a given key, by number $value public delete (mixed $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
$cache->save("users-ids",[1,2,3]); $cache->save("projects-ids",[4,5,6]); var_dump($cache->queryKeys("users")); // ["users-ids"] public exists ([string | int $keyName], [int $lifetime]) Checks if cache exists and it hasn’t expired public flush () Immediately invalidates all existing items.
$cache= new Apc($frontCache,["prefix" =>"app-data"]);
$cache->save("my-data",[1,2,3,4,5]);
// 'my-data' and all other used keys are deleted $cache->flush(); public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) inherited from Phal- con\Cache\Backend Phalcon\Cache\Backend constructor public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend
Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
Class Phalcon\Cache\Backend\File extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments using a file backend
// Cache the file for 2 days $frontendOptions=[ "lifetime" => 172800, ];
// Create an output cache $frontCache= FrontOutput($frontOptions);
// Set the cache directory $backendOptions=[ "cacheDir" =>"../app/cache/", ];
// Create the File backend $cache= new File($frontCache, $backendOptions);
$content= $cache->start("my-cache"); if ($content === null){ echo "
", time(),"
";
$cache->save(); } else { echo $content; }
Methods public __construct (Phalcon\Cache\FrontendInterface $frontend, array $options)
2.5. API 545 Phalcon PHP Framework Documentation, Release 3.1.1
Phalcon\Cache\Backend\File constructor public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend public delete (int | string $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
$cache->save("users-ids",[1,2,3]); $cache->save("projects-ids",[4,5,6]); var_dump($cache->queryKeys("users")); // ["users-ids"] public exists ([string | int $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public increment ([string | int $keyName], [mixed $value]) Increment of a given key, by number $value public decrement ([string | int $keyName], [mixed $value]) Decrement of a given key, by number $value public flush () Immediately invalidates all existing items. public getKey (mixed $key) Return a file-system safe identifier for a given key public useSafeKey (mixed $useSafeKey) Set whether to use the safekey or not public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend
... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
Class Phalcon\Cache\Backend\Libmemcached extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data or raw data to a libmemcached backend. Per default persistent memcached connection pools are used.
use Phalcon\Cache\Backend\Libmemcached; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data for 2 days $frontCache= new FrontData( [ "lifetime" => 172800, ] );
2.5. API 547 Phalcon PHP Framework Documentation, Release 3.1.1
$cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend\Memcache constructor public _connect () Create internal connection to memcached public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend public boolean delete (int | string $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
public exists ([string $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public increment ([string $keyName], [mixed $value]) Increment of given $keyName by $value public decrement ([string $keyName], [mixed $value]) Decrement of $keyName by given $value public flush () Immediately invalidates all existing items. Memcached does not support flush() per default. If you require flush() sup- port, set $config[”statsKey”]. All modified keys are stored in “statsKey”. Note: statsKey has a negative performance impact.
$cache= new \Phalcon\Cache\Backend\Libmemcached( $frontCache, [ "statsKey" =>"_PHCM",
// 'my-data' and all other used keys are deleted $cache->flush(); public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
Class Phalcon\Cache\Backend\Memcache extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data or raw data to a memcache backend This adapter uses the special memcached key “_PHCM” to store all the keys internally used by the adapter
2.5. API 549 Phalcon PHP Framework Documentation, Release 3.1.1
use Phalcon\Cache\Backend\Memcache; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data for 2 days $frontCache= new FrontData( [ "lifetime" => 172800, ] );
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend\Memcache constructor public _connect () Create internal connection to memcached public addServers (mixed $host, mixed $port, [mixed $persistent]) Add servers to memcache pool public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend public boolean delete (int | string $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
public exists ([string $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public increment ([string $keyName], [mixed $value]) Increment of given $keyName by $value public decrement ([string $keyName], [mixed $value]) Decrement of $keyName by given $value public flush () Immediately invalidates all existing items. public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
2.5. API 551 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Cache\Backend\Memory
extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface, Serializable Stores content in memory. Data is lost when the request is finished
use Phalcon\Cache\Backend\Memory; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data $frontCache= new FrontData();
$cache= new Memory($frontCache);
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the backend and stops the frontend public boolean delete (string $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
public exists ([string | int $keyName], [int $lifetime]) Checks if cache exists and it hasn’t expired public increment ([string $keyName], [mixed $value]) Increment of given $keyName by $value public decrement ([string $keyName], [mixed $value]) Decrement of $keyName by given $value public flush ()
Immediately invalidates all existing items. public serialize () Required for interface \Serializable public unserialize (mixed $data) Required for interface \Serializable public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) inherited from Phal- con\Cache\Backend Phalcon\Cache\Backend constructor public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
Class Phalcon\Cache\Backend\Mongo extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data or raw data to a MongoDb backend
2.5. API 553 Phalcon PHP Framework Documentation, Release 3.1.1
use Phalcon\Cache\Backend\Mongo; use Phalcon\Cache\Frontend\Base64;
// Cache data for 2 days $frontCache= new Base64( [ "lifetime" => 172800, ] );
// Create a MongoDB cache $cache= new Mongo( $frontCache, [ "server" =>"mongodb://localhost", "db" =>"caches", "collection" =>"images", ] );
// Cache arbitrary data $cache->save( "my-data", file_get_contents("some-image.jpg") );
// Get data $data= $cache->get("my-data");
Methods
public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend\Mongo constructor final protected MongoCollection _getCollection () Returns a MongoDb collection based on the backend parameters public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend public boolean delete (int | string $keyName) Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
public exists ([string $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public collection->remove(...) gc () gc public increment (int | string $keyName, [mixed $value]) Increment of a given key by $value public decrement (int | string $keyName, [mixed $value]) Decrement of a given key by $value public flush () Immediately invalidates all existing items. public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
2.5. API 555 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Cache\Backend\Redis
extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data or raw data to a redis backend This adapter uses the special redis key “_PHCR” to store all the keys internally used by the adapter
use Phalcon\Cache\Backend\Redis; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data for 2 days $frontCache= new FrontData( [ "lifetime" => 172800, ] );
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend\Redis constructor public _connect () Create internal connection to redis public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend
public exists ([string $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public increment ([string $keyName], [mixed $value]) Increment of given $keyName by $value public decrement ([string $keyName], [mixed $value]) Decrement of $keyName by given $value public flush () Immediately invalidates all existing items. public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content
2.5. API 557 Phalcon PHP Framework Documentation, Release 3.1.1
public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend Gets the last lifetime set
Class Phalcon\Cache\Backend\Xcache
extends abstract class Phalcon\Cache\Backend implements Phalcon\Cache\BackendInterface Allows to cache output fragments, PHP data and raw data using an XCache backend
use Phalcon\Cache\Backend\Xcache; use Phalcon\Cache\Frontend\Data as FrontData;
// Cache data for 2 days $frontCache= new FrontData( [ "lifetime" => 172800, ] );
$cache= new Xcache( $frontCache, [ "prefix" =>"app-data", ] );
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods
public __construct (Phalcon\Cache\FrontendInterface $frontend, [array $options]) Phalcon\Cache\Backend\Xcache constructor public get (mixed $keyName, [mixed $lifetime]) Returns a cached content public save ([int | string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into the file backend and stops the frontend public boolean delete (int | string $keyName)
Deletes a value from the cache by its key public queryKeys ([mixed $prefix]) Query the existing cached keys.
$cache->save("users-ids",[1,2,3]); $cache->save("projects-ids",[4,5,6]); var_dump($cache->queryKeys("users")); // ["users-ids"] public exists ([string $keyName], [int $lifetime]) Checks if cache exists and it isn’t expired public increment (string $keyName, [mixed $value]) Atomic increment of a given key, by number $value public decrement (string $keyName, [mixed $value]) Atomic decrement of a given key, by number $value public flush () Immediately invalidates all existing items. public getFrontend () inherited from Phalcon\Cache\Backend ... public setFrontend (mixed $frontend) inherited from Phalcon\Cache\Backend ... public getOptions () inherited from Phalcon\Cache\Backend ... public setOptions (mixed $options) inherited from Phalcon\Cache\Backend ... public getLastKey () inherited from Phalcon\Cache\Backend ... public setLastKey (mixed $lastKey) inherited from Phalcon\Cache\Backend ... public mixed start (int | string $keyName, [int $lifetime]) inherited from Phalcon\Cache\Backend Starts a cache. The keyname allows to identify the created fragment public stop ([mixed $stopBuffer]) inherited from Phalcon\Cache\Backend Stops the frontend without store any cached content public isFresh () inherited from Phalcon\Cache\Backend Checks whether the last cache is fresh or cached public isStarted () inherited from Phalcon\Cache\Backend Checks whether the cache has starting buffering or not public int getLifetime () inherited from Phalcon\Cache\Backend
2.5. API 559 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the last lifetime set
Class Phalcon\Cache\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Cache\Frontend\Base64 implements Phalcon\Cache\FrontendInterface Allows to cache data converting/deconverting them to base64. This adapter uses the base64_encode/base64_decode PHP’s functions
// Cache the files for 2 days using a Base64 frontend $frontCache= new \Phalcon\Cache\Frontend\Base64( [ "lifetime" => 172800, ] );
//Create a MongoDB cache $cache= new \Phalcon\Cache\Backend\Mongo( $frontCache, [ "server" =>"mongodb://localhost", "db" =>"caches", "collection" =>"images", ] );
$cacheKey="some-image.jpg.cache";
// Try to get cached image $image= $cache->get($cacheKey); if ($image === null){ // Store the image in the cache $cache->save( $cacheKey, file_get_contents("tmp-dir/some-image.jpg") ); } header("Content-Type: image/jpeg"); echo $image;
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Base64 constructor public getLifetime () Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Actually, does nothing in this adapter public string getContent () Returns output cached content
2.5. API 561 Phalcon PHP Framework Documentation, Release 3.1.1 public stop () Stops output frontend public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Frontend\Data implements Phalcon\Cache\FrontendInterface Allows to cache native PHP data in a serialized form
// Cache the files for 2 days using a Data frontend $frontCache= new Data( [ "lifetime" => 172800, ] );
// Create the component that will cache "Data" to a 'File' backend // Set the cache file directory - important to keep the '/' at the end of // of the value for the folder $cache= new File( $frontCache, [ "cacheDir" =>"../app/cache/", ] );
$cacheKey="robots_order_id.cache";
// Try to get cached records $robots= $cache->get($cacheKey); if ($robots === null){ // $robots is null due to cache expiration or data does not exist // Make the database call and populate the variable $robots= Robots::find( [ "order" =>"id", ] );
// Store it in the cache $cache->save($cacheKey, $robots); }
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Data constructor public getLifetime () Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Actually, does nothing public string getContent () Returns output cached content public stop () Stops output frontend public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Frontend\Igbinary extends class Phalcon\Cache\Frontend\Data implements Phalcon\Cache\FrontendInterface Allows to cache native PHP data in a serialized form using igbinary extension
// Cache the files for 2 days using Igbinary frontend $frontCache= new \Phalcon\Cache\Frontend\Igbinary( [ "lifetime" => 172800, ] );
// Create the component that will cache "Igbinary" to a "File" backend // Set the cache file directory - important to keep the "/" at the end of // of the value for the folder $cache= new \Phalcon\Cache\Backend\File( $frontCache, [ "cacheDir" =>"../app/cache/",
2.5. API 563 Phalcon PHP Framework Documentation, Release 3.1.1
] );
$cacheKey="robots_order_id.cache";
// Try to get cached records $robots= $cache->get($cacheKey); if ($robots === null){ // $robots is null due to cache expiration or data do not exist // Make the database call and populate the variable $robots= Robots::find( [ "order" =>"id", ] );
// Store it in the cache $cache->save($cacheKey, $robots); }
// Use $robots :) foreach ($robots as $robot){ echo $robot->name," \n"; }
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Data constructor public getLifetime () Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Actually, does nothing public string getContent () Returns output cached content public stop () Stops output frontend public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Frontend\Json implements Phalcon\Cache\FrontendInterface Allows to cache data converting/deconverting them to JSON. This adapter uses the json_encode/json_decode PHP’s functions As the data is encoded in JSON other systems accessing the same backend could process them
// Cache the data for 2 days $frontCache= new \Phalcon\Cache\Frontend\Json( [ "lifetime" => 172800, ] );
// Cache arbitrary data $cache->save("my-data",[1,2,3,4,5]);
// Get data $data= $cache->get("my-data");
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Base64 constructor public getLifetime () Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Actually, does nothing public string getContent () Returns output cached content public stop () Stops output frontend
2.5. API 565 Phalcon PHP Framework Documentation, Release 3.1.1 public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Frontend\Msgpack extends class Phalcon\Cache\Frontend\Data implements Phalcon\Cache\FrontendInterface Allows to cache native PHP data in a serialized form using msgpack extension This adapter uses a Msgpack frontend to store the cached content and requires msgpack extension.
// Cache the files for 2 days using Msgpack frontend $frontCache= new Msgpack( [ "lifetime" => 172800, ] );
// Create the component that will cache "Msgpack" to a "File" backend // Set the cache file directory - important to keep the "/" at the end of // of the value for the folder $cache= new File( $frontCache, [ "cacheDir" =>"../app/cache/", ] );
$cacheKey="robots_order_id.cache";
// Try to get cached records $robots= $cache->get($cacheKey); if ($robots === null){ // $robots is null due to cache expiration or data do not exist // Make the database call and populate the variable $robots= Robots::find( [ "order" =>"id", ] );
// Store it in the cache $cache->save($cacheKey, $robots); }
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Msgpack constructor public getLifetime () Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Actually, does nothing public getContent () Returns output cached content public stop () Stops output frontend public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Frontend\None implements Phalcon\Cache\FrontendInterface Discards any kind of frontend data input. This frontend does not have expiration time or any other options
//Create a None Cache $frontCache= new \Phalcon\Cache\Frontend\None();
// Create the component that will cache "Data" to a "Memcached" backend // Memcached connection settings $cache= new \Phalcon\Cache\Backend\Memcache( $frontCache, [ "host" =>"localhost", "port" =>"11211", ] );
$cacheKey="robots_order_id.cache";
2.5. API 567 Phalcon PHP Framework Documentation, Release 3.1.1
// This Frontend always return the data as it's returned by the backend $robots= $cache->get($cacheKey); if ($robots === null){ // This cache doesn't perform any expiration checking, so the data is always
˓→expired // Make the database call and populate the variable $robots= Robots::find( [ "order" =>"id", ] );
$cache->save($cacheKey, $robots); }
// Use $robots :) foreach ($robots as $robot){ echo $robot->name," \n"; }
Methods public getLifetime () Returns cache lifetime, always one second expiring content public isBuffering () Check whether if frontend is buffering output, always false public start () Starts output frontend public string getContent () Returns output cached content public stop () Stops output frontend public beforeStore (mixed $data) Prepare data to be stored public afterRetrieve (mixed $data) Prepares data to be retrieved to user
Class Phalcon\Cache\Frontend\Output implements Phalcon\Cache\FrontendInterface Allows to cache output fragments captured with ob_* functions
* * use Phalcon\Tag; * use Phalcon\Cache\Backend\File; * use Phalcon\Cache\Frontend\Output; * * // Create an Output frontend. Cache the files for 2 days * $frontCache= new Output( * [ * "lifetime" => 172800, * ] * ); * * // Create the component that will cache from the "Output" to a "File" backend * // Set the cache file directory - it's important to keep the "/" at the end of * // the value for the folder * $cache= new File( * $frontCache, * [ * "cacheDir" =>"../app/cache/", * ] * ); * * // Get/Set the cache file to ../app/cache/my-cache.html * $content= $cache->start("my-cache.html"); * * // If $content is null then the content will be generated for the cache * if (null === $content){ * // Print date and time * echo date("r"); * * // Generate a link to the sign-up action * echo Tag::linkTo( * [ * "user/signup", * "Sign Up", * "class" =>"signup-button", * ] * ); * * // Store the output into the cache file * $cache->save(); * } else { * // Echo the cached output * echo $content; * }
•
Methods public __construct ([array $frontendOptions]) Phalcon\Cache\Frontend\Output constructor public getLifetime ()
2.5. API 569 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the cache lifetime public isBuffering () Check whether if frontend is buffering output public start () Starts output frontend. Currently, does nothing public string getContent () Returns output cached content public stop () Stops output frontend public beforeStore (mixed $data) Serializes data before storing them public afterRetrieve (mixed $data) Unserializes data after retrieval
Class Phalcon\Cache\Multiple
Allows to read to chained backend adapters writing to multiple backends
use Phalcon\Cache\Frontend\Data as DataFrontend; use Phalcon\Cache\Multiple; use Phalcon\Cache\Backend\Apc as ApcCache; use Phalcon\Cache\Backend\Memcache as MemcacheCache; use Phalcon\Cache\Backend\File as FileCache;
$ultraFastFrontend= new DataFrontend( [ "lifetime" => 3600, ] );
$fastFrontend= new DataFrontend( [ "lifetime" => 86400, ] );
$slowFrontend= new DataFrontend( [ "lifetime" => 604800, ] );
//Backends are registered from the fastest to the slower $cache= new Multiple( [ new ApcCache( $ultraFastFrontend, [
//Save, saves in every backend $cache->save("my-key", $data);
Methods
public __construct ([Phalcon\Cache\BackendInterface[] $backends]) Phalcon\Cache\Multiple constructor public push (Phalcon\Cache\BackendInterface $backend) Adds a backend public mixed get (string | int $keyName, [int $lifetime]) Returns a cached content reading the internal backends public start (string | int $keyName, [int $lifetime]) Starts every backend public save ([string $keyName], [string $content], [int $lifetime], [boolean $stopBuffer]) Stores cached content into all backends and stops the frontend public boolean delete (string | int $keyName) Deletes a value from each backend public exists ([string | int $keyName], [int $lifetime]) Checks if cache exists in at least one backend public flush () Flush all backend(s)
Class Phalcon\Cli\Console
extends abstract class Phalcon\Application
2.5. API 571 Phalcon PHP Framework Documentation, Release 3.1.1
implements Phalcon\Di\InjectionAwareInterface, Phalcon\Events\EventsAwareInterface This component allows to create CLI applications using Phalcon
Methods public addModules (array $modules) Merge modules with the existing ones
public handle ([array $arguments]) Handle the whole command-line tasks public setArgument ([array $arguments], [mixed $str], [mixed $shift]) Set an specific argument public __construct ([Phalcon\DiInterface $dependencyInjector]) inherited from Phalcon\Application Phalcon\Application public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Application Sets the events manager public getEventsManager () inherited from Phalcon\Application Returns the internal event manager public registerModules (array $modules, [mixed $merge]) inherited from Phalcon\Application Register an array of modules present in the application
Return the modules registered in the application public getModule (mixed $name) inherited from Phalcon\Application Gets the module definition registered in the application via module name public setDefaultModule (mixed $defaultModule) inherited from Phalcon\Application Sets the module name to be used if the router doesn’t return a valid module public getDefaultModule () inherited from Phalcon\Application Returns the default module name public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Cli\Console\Exception extends class Phalcon\Application\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception
2.5. API 573 Phalcon PHP Framework Documentation, Release 3.1.1
Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Cli\Dispatcher
extends abstract class Phalcon\Dispatcher implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\DispatcherInterface, Phalcon\Cli\DispatcherInterface Dispatching is the process of taking the command-line arguments, extracting the module name, task name, action name, and optional parameters contained in it, and then instantiating a task and calling an action on it.
public setTaskSuffix (mixed $taskSuffix) Sets the default task suffix public setDefaultTask (mixed $taskName) Sets the default task name public setTaskName (mixed $taskName)
Sets the task name to be dispatched public getTaskName () Gets last dispatched task name protected _throwDispatchException (mixed $message, [mixed $exceptionCode]) Throws an internal exception protected _handleException (Exception $exception) Handles a user exception public getLastTask () Returns the latest dispatched controller public getActiveTask () Returns the active task in the dispatcher public setOptions (array $options) Set the options to be dispatched public getOptions () Get dispatched options public callActionMethod (mixed $handler, mixed $actionMethod, [array $params]) ... public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Dispatcher Sets the dependency injector public getDI () inherited from Phalcon\Dispatcher Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Dispatcher Sets the events manager public getEventsManager () inherited from Phalcon\Dispatcher Returns the internal event manager public setActionSuffix (mixed $actionSuffix) inherited from Phalcon\Dispatcher Sets the default action suffix public getActionSuffix () inherited from Phalcon\Dispatcher Gets the default action suffix public setModuleName (mixed $moduleName) inherited from Phalcon\Dispatcher Sets the module where the controller is (only informative) public getModuleName () inherited from Phalcon\Dispatcher Gets the module where the controller class is public setNamespaceName (mixed $namespaceName) inherited from Phalcon\Dispatcher Sets the namespace where the controller class is public getNamespaceName () inherited from Phalcon\Dispatcher
2.5. API 575 Phalcon PHP Framework Documentation, Release 3.1.1
Gets a namespace to be prepended to the current handler name public setDefaultNamespace (mixed $namespaceName) inherited from Phalcon\Dispatcher Sets the default namespace public getDefaultNamespace () inherited from Phalcon\Dispatcher Returns the default namespace public setDefaultAction (mixed $actionName) inherited from Phalcon\Dispatcher Sets the default action name public setActionName (mixed $actionName) inherited from Phalcon\Dispatcher Sets the action name to be dispatched public getActionName () inherited from Phalcon\Dispatcher Gets the latest dispatched action name public setParams (array $params) inherited from Phalcon\Dispatcher Sets action params to be dispatched public getParams () inherited from Phalcon\Dispatcher Gets action params public setParam (mixed $param, mixed $value) inherited from Phalcon\Dispatcher Set a param by its name or numeric index public mixed getParam (mixed $param, [string | array $filters], [mixed $defaultValue]) inherited from Phal- con\Dispatcher Gets a param by its name or numeric index public boolean hasParam (mixed $param) inherited from Phalcon\Dispatcher Check if a param exists public getActiveMethod () inherited from Phalcon\Dispatcher Returns the current method to be/executed in the dispatcher public isFinished () inherited from Phalcon\Dispatcher Checks if the dispatch loop is finished or has more pendent controllers/tasks to dispatch public setReturnedValue (mixed $value) inherited from Phalcon\Dispatcher Sets the latest returned value by an action manually public mixed getReturnedValue () inherited from Phalcon\Dispatcher Returns value returned by the latest dispatched action public setModelBinding (mixed $value, [mixed $cache]) inherited from Phalcon\Dispatcher Enable/Disable model binding during dispatch
$di->set('dispatcher', function() { $dispatcher= new Dispatcher();
return $dispatcher; }); public setModelBinder (Phalcon\Mvc\Model\BinderInterface $modelBinder, [mixed $cache]) inherited from Phal- con\Dispatcher Enable model binding during dispatch
$di->set('dispatcher', function() { $dispatcher= new Dispatcher();
$dispatcher->setModelBinder(new Binder(), 'cache'); return $dispatcher; }); public getModelBinder () inherited from Phalcon\Dispatcher Gets model binder public object dispatch () inherited from Phalcon\Dispatcher Dispatches a handle action taking into account the routing parameters protected object _dispatch () inherited from Phalcon\Dispatcher Dispatches a handle action taking into account the routing parameters public forward (array $forward) inherited from Phalcon\Dispatcher Forwards the execution flow to another controller/action Dispatchers are unique per module. Forwarding between modules is not allowed
$this->dispatcher->forward( [ "controller" =>"posts", "action" =>"index", ] ); public wasForwarded () inherited from Phalcon\Dispatcher Check if the current executed action was forwarded by another one public getHandlerClass () inherited from Phalcon\Dispatcher Possible class name that will be located to dispatch the request public getBoundModels () inherited from Phalcon\Dispatcher Returns bound models from binder instance
dispatcher->getBoundModels(); // return array with $user
2.5. API 577 Phalcon PHP Framework Documentation, Release 3.1.1
} } protected _resolveEmptyProperties () inherited from Phalcon\Dispatcher Set empty properties to their defaults (where defaults are available)
Class Phalcon\Cli\Dispatcher\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
implements Phalcon\Di\InjectionAwareInterface Phalcon\Cli\Router is the standard framework router. Routing is the process of taking a command-line arguments and decomposing it into parameters to determine which module, task, and action of that task should receive the request
public __construct ([mixed $defaultRoutes]) Phalcon\Cli\Router constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setDefaultModule (mixed $moduleName) Sets the name of the default module public setDefaultTask (mixed $taskName) Sets the default controller name public setDefaultAction (mixed $actionName) Sets the default action name public setDefaults (array $defaults) Sets an array of default paths. If a route is missing a path the router will use the defined here This method must not be used to set a 404 route
2.5. API 579 Phalcon PHP Framework Documentation, Release 3.1.1
public handle ([array $arguments]) Handles routing information received from command-line arguments public Phalcon\Cli\Router\Route add (string $pattern, [string/array $paths]) Adds a route to the router
$router->add("/about","About::main");
public getModuleName () Returns processed module name public getTaskName () Returns processed task name public getActionName () Returns processed action name public array getParams () Returns processed extra params public getMatchedRoute () Returns the route that matches the handled URI public array getMatches () Returns the sub expressions in the regular expression matched public wasMatched () Checks if the router matches any of the defined routes public getRoutes () Returns all the routes defined in the router public Phalcon\Cli\Router\Route getRouteById (int $id) Returns a route object by its id public getRouteByName (mixed $name) Returns a route object by its name
Class Phalcon\Cli\Router\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception
Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Cli\Router\Route
This class represents every route added to the router
Constants string DEFAULT_DELIMITER
Methods public __construct (string $pattern, [array $paths]) Phalcon\Cli\Router\Route constructor public compilePattern (mixed $pattern) Replaces placeholders from pattern returning a valid PCRE regular expression public array | boolean extractNamedParams (string $pattern) Extracts parameters from a string public reConfigure (string $pattern, [array $paths]) Reconfigure the route adding a new pattern and a set of paths
2.5. API 581 Phalcon PHP Framework Documentation, Release 3.1.1
public getName () Returns the route’s name public setName (mixed $name) Sets the route’s name
public Phalcon\Cli\Router\Route beforeMatch (callback $callback) Sets a callback that is called if the route is matched. The developer can implement any arbitrary conditions here If the callback returns false the route is treated as not matched public mixed getBeforeMatch () Returns the ‘before match’ callback if any public getRouteId () Returns the route’s id public getPattern () Returns the route’s pattern public getCompiledPattern () Returns the route’s compiled pattern public getPaths () Returns the paths public getReversedPaths () Returns the paths using positions as keys and names as values public Phalcon\Cli\Router\Route convert (string $name, callable $converter) Adds a converter to perform an additional transformation for certain parameter public getConverters () Returns the router converter public static reset () Resets the internal route id generator public static delimiter ([mixed $delimiter]) Set the routing delimiter public static getDelimiter () Get routing delimiter
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\Cli\TaskInterface Every command-line task should extend this class that encapsulates all the task functionality A task can be used to run “tasks” such as migrations, cronjobs, unit-tests, or anything that you want. The Task class should at least have a “mainAction” method
class HelloTask extends \Phalcon\Cli\Task { // This action will be executed by default public function mainAction() {
}
public function findAction() {
} }
Methods
final public __construct () Phalcon\Cli\Task constructor public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Config
implements ArrayAccess, Countable Phalcon\Config is designed to simplify the access to, and the use of, configuration data within applications. It provides a nested object property based user interface for accessing this configuration data within application code.
2.5. API 583 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct ([array $arrayConfig]) Phalcon\Config constructor public offsetExists (mixed $index) Allows to check whether an attribute is defined using the array-syntax
get("controllersDir","../app/controllers/"); public offsetGet (mixed $index) Gets an attribute using the array-syntax
$globalConfig->merge($appConfig); public toArray () Converts recursively the object to an array
toArray() ); public count () Returns the count of properties set in the config
count(); public static __set_state (array $data) Restores the state of a Phalcon\Config object final protected Config merged config _merge (Config $config, [mixed $instance]) Helper method for merge configs (forwarding nested config instance)
2.5. API 585 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Config\Adapter\Ini extends class Phalcon\Config implements Countable, ArrayAccess Reads ini files and converts them to Phalcon\Config objects. Given the next configuration file:
[database] adapter= Mysql host= localhost username= scott password= cheetah dbname= test_db
$config= new \Phalcon\Config\Adapter\Ini("path/config.ini"); echo $config->phalcon->controllersDir; echo $config->database->username;
PHP constants may also be parsed in the ini file, so if you define a constant as an ini value before calling the constructor, the constant’s value will be integrated into the results. To use it this way you must specify the optional second parameter as INI_SCANNER_NORMAL when calling the constructor:
$config= new \Phalcon\Config\Adapter\Ini( "path/config-with-constants.ini", INI_SCANNER_NORMAL );
Methods public __construct (mixed $filePath, [mixed $mode]) Phalcon\Config\Adapter\Ini constructor protected _parseIniString (mixed $path, mixed $value) Build multidimensional array from string
$this->_parseIniString("path.hello.world","value for last key");
// result [ "path" =>[ "hello" =>[ "world" =>"value for last key", ], ], ]; protected _cast (mixed $ini) We have to cast values manually because parse_ini_file() has a poor implementation. public offsetExists (mixed $index) inherited from Phalcon\Config Allows to check whether an attribute is defined using the array-syntax
get("controllersDir","../app/controllers/"); public offsetGet (mixed $index) inherited from Phalcon\Config Gets an attribute using the array-syntax
$config["database"]=[ "type" =>"Sqlite", ]; public offsetUnset (mixed $index) inherited from Phalcon\Config Unsets an attribute using the array-syntax
2.5. API 587 Phalcon PHP Framework Documentation, Release 3.1.1
public merge (Phalcon\Config $config) inherited from Phalcon\Config Merges a configuration into the current one
public toArray () inherited from Phalcon\Config Converts recursively the object to an array
print_r( $config->toArray() );
public count () inherited from Phalcon\Config Returns the count of properties set in the config
print count($config);
or
print $config->count();
public static __set_state (array $data) inherited from Phalcon\Config Restores the state of a Phalcon\Config object final protected Config merged config _merge (Config $config, [mixed $instance]) inherited from Phalcon\Config Helper method for merge configs (forwarding nested config instance)
Class Phalcon\Config\Adapter\Json
extends class Phalcon\Config implements Countable, ArrayAccess Reads JSON files and converts them to Phalcon\Config objects. Given the following configuration file:
$config= new Phalcon\Config\Adapter\Json("path/config.json"); echo $config->phalcon->baseuri; echo $config->models->metadata;
Methods public __construct (mixed $filePath) Phalcon\Config\Adapter\Json constructor public offsetExists (mixed $index) inherited from Phalcon\Config Allows to check whether an attribute is defined using the array-syntax
get("controllersDir","../app/controllers/"); public offsetGet (mixed $index) inherited from Phalcon\Config Gets an attribute using the array-syntax
$config["database"]=[ "type" =>"Sqlite", ]; public offsetUnset (mixed $index) inherited from Phalcon\Config Unsets an attribute using the array-syntax
2.5. API 589 Phalcon PHP Framework Documentation, Release 3.1.1
unset($config["database"]);
public merge (Phalcon\Config $config) inherited from Phalcon\Config Merges a configuration into the current one
public toArray () inherited from Phalcon\Config Converts recursively the object to an array
print_r( $config->toArray() );
public count () inherited from Phalcon\Config Returns the count of properties set in the config
print count($config);
or
print $config->count();
public static __set_state (array $data) inherited from Phalcon\Config Restores the state of a Phalcon\Config object final protected Config merged config _merge (Config $config, [mixed $instance]) inherited from Phalcon\Config Helper method for merge configs (forwarding nested config instance)
Class Phalcon\Config\Adapter\Php
extends class Phalcon\Config implements Countable, ArrayAccess Reads php files and converts them to Phalcon\Config objects.
$config= new \Phalcon\Config\Adapter\Php("path/config.php"); echo $config->phalcon->controllersDir; echo $config->database->username;
Methods public __construct (mixed $filePath) Phalcon\Config\Adapter\Php constructor public offsetExists (mixed $index) inherited from Phalcon\Config Allows to check whether an attribute is defined using the array-syntax
get("controllersDir","../app/controllers/"); public offsetGet (mixed $index) inherited from Phalcon\Config Gets an attribute using the array-syntax
2.5. API 591 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $config["database"] );
public offsetSet (mixed $index, mixed $value) inherited from Phalcon\Config Sets an attribute using the array-syntax
$config["database"]=[ "type" =>"Sqlite", ];
public offsetUnset (mixed $index) inherited from Phalcon\Config Unsets an attribute using the array-syntax
unset($config["database"]);
public merge (Phalcon\Config $config) inherited from Phalcon\Config Merges a configuration into the current one
count(); public static __set_state (array $data) inherited from Phalcon\Config Restores the state of a Phalcon\Config object final protected Config merged config _merge (Config $config, [mixed $instance]) inherited from Phalcon\Config Helper method for merge configs (forwarding nested config instance)
Class Phalcon\Config\Adapter\Yaml extends class Phalcon\Config implements Countable, ArrayAccess Reads YAML files and converts them to Phalcon\Config objects. Given the following configuration file:
Methods public __construct (mixed $filePath, [array $callbacks]) Phalcon\Config\Adapter\Yaml constructor
2.5. API 593 Phalcon PHP Framework Documentation, Release 3.1.1 public offsetExists (mixed $index) inherited from Phalcon\Config Allows to check whether an attribute is defined using the array-syntax
get("controllersDir","../app/controllers/"); public offsetGet (mixed $index) inherited from Phalcon\Config Gets an attribute using the array-syntax
$config["database"]=[ "type" =>"Sqlite", ]; public offsetUnset (mixed $index) inherited from Phalcon\Config Unsets an attribute using the array-syntax
public toArray () inherited from Phalcon\Config Converts recursively the object to an array
print_r( $config->toArray() );
public count () inherited from Phalcon\Config Returns the count of properties set in the config
print count($config);
or
print $config->count();
public static __set_state (array $data) inherited from Phalcon\Config Restores the state of a Phalcon\Config object final protected Config merged config _merge (Config $config, [mixed $instance]) inherited from Phalcon\Config Helper method for merge configs (forwarding nested config instance)
Class Phalcon\Config\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception
2.5. API 595 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Crypt implements Phalcon\CryptInterface Provides encryption facilities to phalcon applications
$crypt= new \Phalcon\Crypt();
$key="le password"; $text="This is a secret text";
Methods public setPadding (mixed $scheme) Changes the padding scheme used public setCipher (mixed $cipher) Sets the cipher algorithm public getCipher () Returns the current cipher public setKey (mixed $key) Sets the encryption key public getKey () Returns the encryption key protected _cryptPadText (mixed $text, mixed $mode, mixed $blockSize, mixed $paddingType) Pads texts before encryption protected _cryptUnpadText (mixed $text, mixed $mode, mixed $blockSize, mixed $paddingType) If the function detects that the text was not padded, it will return it unmodified public encrypt (mixed $text, [mixed $key]) Encrypts a text
$encrypted= $crypt->encrypt("Ultra-secret text","encrypt password"); public decrypt (mixed $text, [mixed $key]) Decrypts an encrypted text
decrypt($encrypted,"decrypt password"); public encryptBase64 (mixed $text, [mixed $key], [mixed $safe]) Encrypts a text returning the result as a base64 string public decryptBase64 (mixed $text, [mixed $key], [mixed $safe]) Decrypt a text that is coded as a base64 string public getAvailableCiphers () Returns a list of available ciphers
Class Phalcon\Crypt\Exception extends class Phalcon\Exception implements Throwable
2.5. API 597 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Db
Phalcon\Db and its related classes provide a simple SQL database interface for Phalcon Framework. The Phalcon\Db is the basic class you use to connect your PHP application to an RDBMS. There is a different adapter class for each brand of RDBMS. This component is intended to lower level database operations. If you want to interact with databases using higher level of abstraction use Phalcon\Mvc\Model. Phalcon\Db is an abstract class. You only can use it with a database adapter like Phalcon\Db\Adapter\Pdo
2.5. API 599 Phalcon PHP Framework Documentation, Release 3.1.1
Enables/disables options in the Database component
Abstract class Phalcon\Db\Adapter
implements Phalcon\Db\AdapterInterface, Phalcon\Events\EventsAwareInterface Base class for Phalcon\Db adapters
Methods
public getDialectType () Name of the dialect used public getType () Type of database system the adapter is used for public getSqlVariables () Active SQL bound parameter variables public __construct (array $descriptor) Phalcon\Db\Adapter constructor public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the event manager public getEventsManager () Returns the internal event manager public setDialect (Phalcon\Db\DialectInterface $dialect) Sets the dialect used to produce the SQL public getDialect () Returns internal dialect instance public fetchOne (mixed $sqlQuery, [mixed $fetchMode], [mixed $bindParams], [mixed $bindTypes]) Returns the first row in a SQL query result
// Getting first robot $robot= $connection->fetchOne("SELECT * FROM robots"); print_r($robot);
// Getting first robot with associative indexes only $robot= $connection->fetchOne("SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC); print_r($robot);
public array fetchAll (string $sqlQuery, [int $fetchMode], [array $bindParams], [array $bindTypes]) Dumps the complete result of a query into an array
// Getting all robots with associative indexes only $robots= $connection->fetchAll( "SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC ); foreach ($robots as $robot){ print_r($robot); }
// Getting all robots that contains word "robot" withing the name $robots= $connection->fetchAll( "SELECT * FROM robots WHERE name LIKE :name", \Phalcon\Db::FETCH_ASSOC, [ "name" =>"%robot%", ] ); foreach($robots as $robot){ print_r($robot); } public string | ** fetchColumn (string $sqlQuery, [array $placeholders], [int | string $column]) Returns the n’th field of first row in a SQL query result
// Getting count of robots $robotsCount= $connection->fetchColumn("SELECT count( *) FROM robots"); print_r($robotsCount);
// Getting name of last edited robot $robot= $connection->fetchColumn( "SELECT id, name FROM robots order by modified desc", 1 ); print_r($robot); public boolean insert (string | array $table, array $values, [array $fields], [array $dataTypes]) Inserts data into a table using custom RDBMS SQL syntax
// Inserting a new robot $success= $connection->insert( "robots", ["Astro Boy", 1952], ["name","year"] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean insertAsDict (string $table, array $data, [array $dataTypes])
2.5. API 601 Phalcon PHP Framework Documentation, Release 3.1.1
Inserts data into a table using custom RBDM SQL syntax
// Inserting a new robot $success= $connection->insertAsDict( "robots", [ "name" =>"Astro Boy", "year" => 1952, ] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean update (string | array $table, array $fields, array $values, [string | array $whereCondition], [array $dataTypes]) Updates data on a table using custom RBDM SQL syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
// Updating existing robot with array condition and $dataTypes $success= $connection->update( "robots", ["name"], ["New Astro Boy"], [ "conditions" =>"id = ?", "bind" =>[$some_unsafe_id], "bindTypes" => [PDO::PARAM_INT], // use only if you use $dataTypes param ], [ PDO::PARAM_STR ] );
Warning! If $whereCondition is string it not escaped. public boolean updateAsDict (string $table, array $data, [string $whereCondition], [array $dataTypes]) Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101 public boolean delete (string | array $table, [string $whereCondition], [array $placeholders], [array $dataTypes]) Deletes data from a table using custom RBDM SQL syntax
// Next SQL sentence is generated DELETE FROM `robots` WHERE `id`= 101 public escapeIdentifier (array | string $identifier) Escapes a column/table/schema name
$escapedTable= $connection->escapeIdentifier( [ "store", "robots", ] ); public string getColumnList (array $columnList) Gets a list of columns public limit (mixed $sqlQuery, mixed $number) Appends a LIMIT clause to $sqlQuery argument
limit("SELECT * FROM robots",5); public tableExists (mixed $tableName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.table
2.5. API 603 Phalcon PHP Framework Documentation, Release 3.1.1
$connection->tableExists("blog","posts") ); public viewExists (mixed $viewName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.view
viewExists("active_users","posts") ); public forUpdate (mixed $sqlQuery) Returns a SQL modified with a FOR UPDATE clause public sharedLock (mixed $sqlQuery) Returns a SQL modified with a LOCK IN SHARE MODE clause public createTable (mixed $tableName, mixed $schemaName, array $definition) Creates a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) Drops a table from a schema/database public createView (mixed $viewName, array $definition, [mixed $schemaName]) Creates a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) Drops a view public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) Adds a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) Modifies a table column based on a definition public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) Drops a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Adds an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) Drop an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Adds a primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) Drops a table’s primary key public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference)
Adds a foreign key to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) Drops a foreign key from a table public getColumnDefinition (Phalcon\Db\ColumnInterface $column) Returns the SQL column definition from a column public listTables ([mixed $schemaName]) List all tables on a database
print_r( $connection->listTables("blog") );
public listViews ([mixed $schemaName]) List all views on a database
print_r( $connection->listViews("blog") );
public Phalcon\Db\Index[] describeIndexes (string $table, [string $schema]) Lists table indexes
public tableOptions (mixed $tableName, [mixed $schemaName]) Gets creation options from a table
print_r( $connection->tableOptions("robots") );
public createSavepoint (mixed $name) Creates a new savepoint
2.5. API 605 Phalcon PHP Framework Documentation, Release 3.1.1
public releaseSavepoint (mixed $name) Releases given savepoint public rollbackSavepoint (mixed $name) Rollbacks given savepoint public setNestedTransactionsWithSavepoints (mixed $nestedTransactionsWithSavepoints) Set if nested transactions should use savepoints public isNestedTransactionsWithSavepoints () Returns if nested transactions should use savepoints public getNestedTransactionSavepointName () Returns the savepoint name to use for nested transactions public getDefaultIdValue () Returns the default identity value to be inserted in an identity column
// Inserting a new robot with a valid default value for the column 'id' $success= $connection->insert( "robots", [ $connection->getDefaultIdValue(), "Astro Boy", 1952, ], [ "id", "name", "year", ] );
public getDefaultValue () Returns the default value to make the RBDM use the default value declared in the table definition
// Inserting a new robot with a valid default value for the column 'year' $success= $connection->insert( "robots", [ "Astro Boy", $connection->getDefaultValue() ], [ "name", "year", ] );
public supportSequences () Check whether the database system requires a sequence to produce auto-numeric values
public useExplicitIdValue () Check whether the database system requires an explicit value for identity columns public getDescriptor () Return descriptor used to connect to the active database public string getConnectionId () Gets the active connection unique identifier public getSQLStatement () Active SQL statement in the object public getRealSQLStatement () Active SQL statement in the object without replace bound parameters public array getSQLBindTypes () Active SQL statement in the object abstract public connect ([array $descriptor]) inherited from Phalcon\Db\AdapterInterface ... abstract public query (mixed $sqlStatement, [mixed $placeholders], [mixed $dataTypes]) inherited from Phal- con\Db\AdapterInterface ... abstract public execute (mixed $sqlStatement, [mixed $placeholders], [mixed $dataTypes]) inherited from Phal- con\Db\AdapterInterface ... abstract public affectedRows () inherited from Phalcon\Db\AdapterInterface ... abstract public close () inherited from Phalcon\Db\AdapterInterface ... abstract public escapeString (mixed $str) inherited from Phalcon\Db\AdapterInterface ... abstract public lastInsertId ([mixed $sequenceName]) inherited from Phalcon\Db\AdapterInterface ... abstract public begin ([mixed $nesting]) inherited from Phalcon\Db\AdapterInterface ... abstract public rollback ([mixed $nesting]) inherited from Phalcon\Db\AdapterInterface ... abstract public commit ([mixed $nesting]) inherited from Phalcon\Db\AdapterInterface ... abstract public isUnderTransaction () inherited from Phalcon\Db\AdapterInterface ... abstract public getInternalHandler () inherited from Phalcon\Db\AdapterInterface
2.5. API 607 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public describeColumns (mixed $table, [mixed $schema]) inherited from Phalcon\Db\AdapterInterface ...
Abstract class Phalcon\Db\Adapter\Pdo extends abstract class Phalcon\Db\Adapter implements Phalcon\Events\EventsAwareInterface, Phalcon\Db\AdapterInterface Phalcon\Db\Adapter\Pdo is the Phalcon\Db that internally uses PDO to connect to a database
Methods public __construct (array $descriptor) Constructor for Phalcon\Db\Adapter\Pdo public connect ([array $descriptor]) This method is automatically called in \Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection.
// Make a connection $connection= new Mysql( [ "host" =>"localhost", "username" =>"sigma", "password" =>"secret", "dbname" =>"blog", "port" => 3306, ] );
// Reconnect $connection->connect();
608 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public prepare (mixed $sqlStatement) Returns a PDO prepared statement to be executed with ‘executePrepared’
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
$result= $connection->executePrepared( $statement, [ "name" =>"Voltron", ], [ "name" => Column::BIND_PARAM_INT, ] ); public PDOStatement executePrepared (PDOStatement $statement, array $placeholders, array $dataTypes) Executes a prepared statement binding. This function uses integer indexes starting from zero
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
$result= $connection->executePrepared( $statement, [ "name" =>"Voltron", ], [ "name" => Column::BIND_PARAM_INT, ] ); public query (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server is returning rows
// Querying data $resultset= $connection->query( "SELECT * FROM robots WHERE type = 'mechanical'" );
$resultset= $connection->query( "SELECT * FROM robots WHERE type = ?", [ "mechanical",
2.5. API 609 Phalcon PHP Framework Documentation, Release 3.1.1
] ); public execute (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server doesn’t return any rows
// Inserting data $success= $connection->execute( "INSERT INTO robots VALUES (1, 'Astro Boy')" );
$success= $connection->execute( "INSERT INTO robots VALUES (?, ?)", [ 1, "Astro Boy", ] ); public affectedRows () Returns the number of affected rows by the latest INSERT/UPDATE/DELETE executed in the database system
$connection->execute( "DELETE FROM robots" ); echo $connection->affectedRows()," were deleted"; public close () Closes the active connection returning success. Phalcon automatically closes and destroys active connections when the request ends public escapeString (mixed $str) Escapes a value to avoid SQL injections according to the active charset in the connection
$escapedStr= $connection->escapeString("some dangerous value"); public convertBoundParams (mixed $sql, [array $params]) Converts bound parameters such as :name: or ?1 into PDO bind params ?
convertBoundParams( "SELECT * FROM robots WHERE name = :name:", [ "Bender", ]
public int | boolean lastInsertId ([string $sequenceName]) Returns the insert id for the auto_increment/serial column inserted in the latest executed SQL statement
// Inserting a new robot $success= $connection->insert( "robots", [ "Astro Boy", 1952, ], [ "name", "year", ] );
// Getting the generated id $id= $connection->lastInsertId();
public begin ([mixed $nesting]) Starts a transaction in the connection public rollback ([mixed $nesting]) Rollbacks the active transaction in the connection public commit ([mixed $nesting]) Commits the active transaction in the connection public getTransactionLevel () Returns the current transaction nesting level public isUnderTransaction () Checks whether the connection is under a transaction
public getInternalHandler () Return internal PDO handler public array getErrorInfo () Return the error info, if any public getDialectType () inherited from Phalcon\Db\Adapter
2.5. API 611 Phalcon PHP Framework Documentation, Release 3.1.1
Name of the dialect used public getType () inherited from Phalcon\Db\Adapter Type of database system the adapter is used for public getSqlVariables () inherited from Phalcon\Db\Adapter Active SQL bound parameter variables public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Db\Adapter Sets the event manager public getEventsManager () inherited from Phalcon\Db\Adapter Returns the internal event manager public setDialect (Phalcon\Db\DialectInterface $dialect) inherited from Phalcon\Db\Adapter Sets the dialect used to produce the SQL public getDialect () inherited from Phalcon\Db\Adapter Returns internal dialect instance public fetchOne (mixed $sqlQuery, [mixed $fetchMode], [mixed $bindParams], [mixed $bindTypes]) inherited from Phalcon\Db\Adapter Returns the first row in a SQL query result
// Getting first robot $robot= $connection->fetchOne("SELECT * FROM robots"); print_r($robot);
// Getting first robot with associative indexes only $robot= $connection->fetchOne("SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC); print_r($robot);
public array fetchAll (string $sqlQuery, [int $fetchMode], [array $bindParams], [array $bindTypes]) inherited from Phalcon\Db\Adapter Dumps the complete result of a query into an array
// Getting all robots with associative indexes only $robots= $connection->fetchAll( "SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC );
foreach ($robots as $robot){ print_r($robot); }
// Getting all robots that contains word "robot" withing the name $robots= $connection->fetchAll( "SELECT * FROM robots WHERE name LIKE :name", \Phalcon\Db::FETCH_ASSOC, [ "name" =>"%robot%",
] ); foreach($robots as $robot){ print_r($robot); } public string | ** fetchColumn (string $sqlQuery, [array $placeholders], [int | string $column]) inherited from Phal- con\Db\Adapter Returns the n’th field of first row in a SQL query result
// Getting count of robots $robotsCount= $connection->fetchColumn("SELECT count( *) FROM robots"); print_r($robotsCount);
// Getting name of last edited robot $robot= $connection->fetchColumn( "SELECT id, name FROM robots order by modified desc", 1 ); print_r($robot); public boolean insert (string | array $table, array $values, [array $fields], [array $dataTypes]) inherited from Phal- con\Db\Adapter Inserts data into a table using custom RDBMS SQL syntax
// Inserting a new robot $success= $connection->insert( "robots", ["Astro Boy", 1952], ["name","year"] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean insertAsDict (string $table, array $data, [array $dataTypes]) inherited from Phalcon\Db\Adapter Inserts data into a table using custom RBDM SQL syntax
// Inserting a new robot $success= $connection->insertAsDict( "robots", [ "name" =>"Astro Boy", "year" => 1952, ] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952);
2.5. API 613 Phalcon PHP Framework Documentation, Release 3.1.1
public boolean update (string | array $table, array $fields, array $values, [string | array $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
// Updating existing robot with array condition and $dataTypes $success= $connection->update( "robots", ["name"], ["New Astro Boy"], [ "conditions" =>"id = ?", "bind" =>[$some_unsafe_id], "bindTypes" => [PDO::PARAM_INT], // use only if you use $dataTypes param ], [ PDO::PARAM_STR ] );
Warning! If $whereCondition is string it not escaped. public boolean updateAsDict (string $table, array $data, [string $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
public boolean delete (string | array $table, [string $whereCondition], [array $placeholders], [array $dataTypes]) inherited from Phalcon\Db\Adapter Deletes data from a table using custom RBDM SQL syntax
// Next SQL sentence is generated DELETE FROM `robots` WHERE `id`= 101 public escapeIdentifier (array | string $identifier) inherited from Phalcon\Db\Adapter Escapes a column/table/schema name
$escapedTable= $connection->escapeIdentifier( [ "store", "robots", ] ); public string getColumnList (array $columnList) inherited from Phalcon\Db\Adapter Gets a list of columns public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Adapter Appends a LIMIT clause to $sqlQuery argument
limit("SELECT * FROM robots",5); public tableExists (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.table
tableExists("blog","posts") ); public viewExists (mixed $viewName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.view
viewExists("active_users","posts") );
2.5. API 615 Phalcon PHP Framework Documentation, Release 3.1.1
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a FOR UPDATE clause public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a LOCK IN SHARE MODE clause public createTable (mixed $tableName, mixed $schemaName, array $definition) inherited from Phalcon\Db\Adapter Creates a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a table from a schema/database public createView (mixed $viewName, array $definition, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Creates a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a view public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Adds a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) inherited from Phalcon\Db\Adapter Modifies a table column based on a definition public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) inherited from Phal- con\Db\Adapter Drops a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phal- con\Db\Adapter Adds an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) inherited from Phal- con\Db\Adapter Drop an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phalcon\Db\Adapter Adds a primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) inherited from Phalcon\Db\Adapter Drops a table’s primary key public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) inher- ited from Phalcon\Db\Adapter Adds a foreign key to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) inherited from Phal- con\Db\Adapter Drops a foreign key from a table public getColumnDefinition (Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter
public tableOptions (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Gets creation options from a table
print_r( $connection->tableOptions("robots") );
public createSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Creates a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Releases given savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Rollbacks given savepoint
2.5. API 617 Phalcon PHP Framework Documentation, Release 3.1.1
public setNestedTransactionsWithSavepoints (mixed $nestedTransactionsWithSavepoints) inherited from Phal- con\Db\Adapter Set if nested transactions should use savepoints public isNestedTransactionsWithSavepoints () inherited from Phalcon\Db\Adapter Returns if nested transactions should use savepoints public getNestedTransactionSavepointName () inherited from Phalcon\Db\Adapter Returns the savepoint name to use for nested transactions public getDefaultIdValue () inherited from Phalcon\Db\Adapter Returns the default identity value to be inserted in an identity column
// Inserting a new robot with a valid default value for the column 'id' $success= $connection->insert( "robots", [ $connection->getDefaultIdValue(), "Astro Boy", 1952, ], [ "id", "name", "year", ] );
public getDefaultValue () inherited from Phalcon\Db\Adapter Returns the default value to make the RBDM use the default value declared in the table definition
// Inserting a new robot with a valid default value for the column 'year' $success= $connection->insert( "robots", [ "Astro Boy", $connection->getDefaultValue() ], [ "name", "year", ] );
public supportSequences () inherited from Phalcon\Db\Adapter Check whether the database system requires a sequence to produce auto-numeric values public useExplicitIdValue () inherited from Phalcon\Db\Adapter Check whether the database system requires an explicit value for identity columns public getDescriptor () inherited from Phalcon\Db\Adapter
Return descriptor used to connect to the active database public string getConnectionId () inherited from Phalcon\Db\Adapter Gets the active connection unique identifier public getSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object public getRealSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object without replace bound parameters public array getSQLBindTypes () inherited from Phalcon\Db\Adapter Active SQL statement in the object abstract public describeColumns (mixed $table, [mixed $schema]) inherited from Phalcon\Db\AdapterInterface ...
Class Phalcon\Db\Adapter\Pdo\Mysql
extends abstract class Phalcon\Db\Adapter\Pdo implements Phalcon\Db\AdapterInterface, Phalcon\Events\EventsAwareInterface Specific functions for the Mysql database system
public __construct (array $descriptor) inherited from Phalcon\Db\Adapter\Pdo Constructor for Phalcon\Db\Adapter\Pdo public connect ([array $descriptor]) inherited from Phalcon\Db\Adapter\Pdo This method is automatically called in \Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection.
use Phalcon\Db\Adapter\Pdo\Mysql;
// Make a connection $connection= new Mysql( [ "host" =>"localhost", "username" =>"sigma", "password" =>"secret", "dbname" =>"blog", "port" => 3306, ] );
// Reconnect $connection->connect();
public prepare (mixed $sqlStatement) inherited from Phalcon\Db\Adapter\Pdo Returns a PDO prepared statement to be executed with ‘executePrepared’
use Phalcon\Db\Column;
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
[ "name" => Column::BIND_PARAM_INT, ] ); public PDOStatement executePrepared (PDOStatement $statement, array $placeholders, array $dataTypes) inherited from Phalcon\Db\Adapter\Pdo Executes a prepared statement binding. This function uses integer indexes starting from zero
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
$result= $connection->executePrepared( $statement, [ "name" =>"Voltron", ], [ "name" => Column::BIND_PARAM_INT, ] ); public query (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server is returning rows
// Querying data $resultset= $connection->query( "SELECT * FROM robots WHERE type = 'mechanical'" );
$resultset= $connection->query( "SELECT * FROM robots WHERE type = ?", [ "mechanical", ] ); public execute (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server doesn’t return any rows
// Inserting data $success= $connection->execute( "INSERT INTO robots VALUES (1, 'Astro Boy')"
2.5. API 621 Phalcon PHP Framework Documentation, Release 3.1.1
public affectedRows () inherited from Phalcon\Db\Adapter\Pdo Returns the number of affected rows by the latest INSERT/UPDATE/DELETE executed in the database system
$connection->execute( "DELETE FROM robots" );
echo $connection->affectedRows()," were deleted";
public close () inherited from Phalcon\Db\Adapter\Pdo Closes the active connection returning success. Phalcon automatically closes and destroys active connections when the request ends public escapeString (mixed $str) inherited from Phalcon\Db\Adapter\Pdo Escapes a value to avoid SQL injections according to the active charset in the connection
public convertBoundParams (mixed $sql, [array $params]) inherited from Phalcon\Db\Adapter\Pdo Converts bound parameters such as :name: or ?1 into PDO bind params ?
print_r( $connection->convertBoundParams( "SELECT * FROM robots WHERE name = :name:", [ "Bender", ] ) );
public int | boolean lastInsertId ([string $sequenceName]) inherited from Phalcon\Db\Adapter\Pdo Returns the insert id for the auto_increment/serial column inserted in the latest executed SQL statement
// Inserting a new robot $success= $connection->insert( "robots", [
// Getting the generated id $id= $connection->lastInsertId();
public begin ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Starts a transaction in the connection public rollback ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Rollbacks the active transaction in the connection public commit ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Commits the active transaction in the connection public getTransactionLevel () inherited from Phalcon\Db\Adapter\Pdo Returns the current transaction nesting level public isUnderTransaction () inherited from Phalcon\Db\Adapter\Pdo Checks whether the connection is under a transaction
public getInternalHandler () inherited from Phalcon\Db\Adapter\Pdo Return internal PDO handler public array getErrorInfo () inherited from Phalcon\Db\Adapter\Pdo Return the error info, if any public getDialectType () inherited from Phalcon\Db\Adapter Name of the dialect used public getType () inherited from Phalcon\Db\Adapter Type of database system the adapter is used for public getSqlVariables () inherited from Phalcon\Db\Adapter Active SQL bound parameter variables public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Db\Adapter Sets the event manager public getEventsManager () inherited from Phalcon\Db\Adapter
2.5. API 623 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the internal event manager public setDialect (Phalcon\Db\DialectInterface $dialect) inherited from Phalcon\Db\Adapter Sets the dialect used to produce the SQL public getDialect () inherited from Phalcon\Db\Adapter Returns internal dialect instance public fetchOne (mixed $sqlQuery, [mixed $fetchMode], [mixed $bindParams], [mixed $bindTypes]) inherited from Phalcon\Db\Adapter Returns the first row in a SQL query result
// Getting first robot $robot= $connection->fetchOne("SELECT * FROM robots"); print_r($robot);
// Getting first robot with associative indexes only $robot= $connection->fetchOne("SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC); print_r($robot);
public array fetchAll (string $sqlQuery, [int $fetchMode], [array $bindParams], [array $bindTypes]) inherited from Phalcon\Db\Adapter Dumps the complete result of a query into an array
// Getting all robots with associative indexes only $robots= $connection->fetchAll( "SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC );
foreach ($robots as $robot){ print_r($robot); }
// Getting all robots that contains word "robot" withing the name $robots= $connection->fetchAll( "SELECT * FROM robots WHERE name LIKE :name", \Phalcon\Db::FETCH_ASSOC, [ "name" =>"%robot%", ] ); foreach($robots as $robot){ print_r($robot); }
public string | ** fetchColumn (string $sqlQuery, [array $placeholders], [int | string $column]) inherited from Phal- con\Db\Adapter Returns the n’th field of first row in a SQL query result
// Getting count of robots $robotsCount= $connection->fetchColumn("SELECT count( *) FROM robots"); print_r($robotsCount);
// Getting name of last edited robot $robot= $connection->fetchColumn( "SELECT id, name FROM robots order by modified desc", 1 ); print_r($robot); public boolean insert (string | array $table, array $values, [array $fields], [array $dataTypes]) inherited from Phal- con\Db\Adapter Inserts data into a table using custom RDBMS SQL syntax
// Inserting a new robot $success= $connection->insert( "robots", ["Astro Boy", 1952], ["name","year"] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean insertAsDict (string $table, array $data, [array $dataTypes]) inherited from Phalcon\Db\Adapter Inserts data into a table using custom RBDM SQL syntax
// Inserting a new robot $success= $connection->insertAsDict( "robots", [ "name" =>"Astro Boy", "year" => 1952, ] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean update (string | array $table, array $fields, array $values, [string | array $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax
2.5. API 625 Phalcon PHP Framework Documentation, Release 3.1.1
);
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
// Updating existing robot with array condition and $dataTypes $success= $connection->update( "robots", ["name"], ["New Astro Boy"], [ "conditions" =>"id = ?", "bind" =>[$some_unsafe_id], "bindTypes" => [PDO::PARAM_INT], // use only if you use $dataTypes param ], [ PDO::PARAM_STR ] );
Warning! If $whereCondition is string it not escaped. public boolean updateAsDict (string $table, array $data, [string $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101 public boolean delete (string | array $table, [string $whereCondition], [array $placeholders], [array $dataTypes]) inherited from Phalcon\Db\Adapter Deletes data from a table using custom RBDM SQL syntax
// Next SQL sentence is generated DELETE FROM `robots` WHERE `id`= 101 public escapeIdentifier (array | string $identifier) inherited from Phalcon\Db\Adapter
public string getColumnList (array $columnList) inherited from Phalcon\Db\Adapter Gets a list of columns public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Adapter Appends a LIMIT clause to $sqlQuery argument
echo $connection->limit("SELECT * FROM robots",5);
public tableExists (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.table
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a FOR UPDATE clause public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a LOCK IN SHARE MODE clause public createTable (mixed $tableName, mixed $schemaName, array $definition) inherited from Phalcon\Db\Adapter Creates a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a table from a schema/database
2.5. API 627 Phalcon PHP Framework Documentation, Release 3.1.1
public createView (mixed $viewName, array $definition, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Creates a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a view public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Adds a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) inherited from Phalcon\Db\Adapter Modifies a table column based on a definition public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) inherited from Phal- con\Db\Adapter Drops a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phal- con\Db\Adapter Adds an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) inherited from Phal- con\Db\Adapter Drop an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phalcon\Db\Adapter Adds a primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) inherited from Phalcon\Db\Adapter Drops a table’s primary key public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) inher- ited from Phalcon\Db\Adapter Adds a foreign key to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) inherited from Phal- con\Db\Adapter Drops a foreign key from a table public getColumnDefinition (Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Returns the SQL column definition from a column public listTables ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all tables on a database
public listViews ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all views on a database
print_r( $connection->listViews("blog") );
public tableOptions (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Gets creation options from a table
print_r( $connection->tableOptions("robots") );
public createSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Creates a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Releases given savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Rollbacks given savepoint public setNestedTransactionsWithSavepoints (mixed $nestedTransactionsWithSavepoints) inherited from Phal- con\Db\Adapter Set if nested transactions should use savepoints public isNestedTransactionsWithSavepoints () inherited from Phalcon\Db\Adapter Returns if nested transactions should use savepoints public getNestedTransactionSavepointName () inherited from Phalcon\Db\Adapter Returns the savepoint name to use for nested transactions public getDefaultIdValue () inherited from Phalcon\Db\Adapter Returns the default identity value to be inserted in an identity column
// Inserting a new robot with a valid default value for the column 'id' $success= $connection->insert( "robots", [ $connection->getDefaultIdValue(), "Astro Boy", 1952, ], [ "id", "name", "year",
2.5. API 629 Phalcon PHP Framework Documentation, Release 3.1.1
] );
public getDefaultValue () inherited from Phalcon\Db\Adapter Returns the default value to make the RBDM use the default value declared in the table definition
// Inserting a new robot with a valid default value for the column 'year' $success= $connection->insert( "robots", [ "Astro Boy", $connection->getDefaultValue() ], [ "name", "year", ] );
public supportSequences () inherited from Phalcon\Db\Adapter Check whether the database system requires a sequence to produce auto-numeric values public useExplicitIdValue () inherited from Phalcon\Db\Adapter Check whether the database system requires an explicit value for identity columns public getDescriptor () inherited from Phalcon\Db\Adapter Return descriptor used to connect to the active database public string getConnectionId () inherited from Phalcon\Db\Adapter Gets the active connection unique identifier public getSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object public getRealSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object without replace bound parameters public array getSQLBindTypes () inherited from Phalcon\Db\Adapter Active SQL statement in the object
Class Phalcon\Db\Adapter\Pdo\Postgresql extends abstract class Phalcon\Db\Adapter\Pdo implements Phalcon\Db\AdapterInterface, Phalcon\Events\EventsAwareInterface Specific functions for the Postgresql database system
Methods public connect ([array $descriptor]) This method is automatically called in Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection. public describeColumns (mixed $table, [mixed $schema]) Returns an array of Phalcon\Db\Column objects describing a table
describeColumns("posts") ); public createTable (mixed $tableName, mixed $schemaName, array $definition) Creates a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) Modifies a table column based on a definition public useExplicitIdValue () Check whether the database system requires an explicit value for identity columns public getDefaultIdValue () Returns the default identity value to be inserted in an identity column
// Inserting a new robot with a valid default value for the column 'id' $success= $connection->insert( "robots", [ $connection->getDefaultIdValue(), "Astro Boy", 1952, ], [ "id", "name", "year", ] );
2.5. API 631 Phalcon PHP Framework Documentation, Release 3.1.1
public supportSequences () Check whether the database system requires a sequence to produce auto-numeric values public __construct (array $descriptor) inherited from Phalcon\Db\Adapter\Pdo Constructor for Phalcon\Db\Adapter\Pdo public prepare (mixed $sqlStatement) inherited from Phalcon\Db\Adapter\Pdo Returns a PDO prepared statement to be executed with ‘executePrepared’
use Phalcon\Db\Column;
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
public PDOStatement executePrepared (PDOStatement $statement, array $placeholders, array $dataTypes) inherited from Phalcon\Db\Adapter\Pdo Executes a prepared statement binding. This function uses integer indexes starting from zero
use Phalcon\Db\Column;
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
public query (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server is returning rows
// Querying data $resultset= $connection->query( "SELECT * FROM robots WHERE type = 'mechanical'" );
$resultset= $connection->query( "SELECT * FROM robots WHERE type = ?", [ "mechanical", ] );
public execute (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server doesn’t return any rows
// Inserting data $success= $connection->execute( "INSERT INTO robots VALUES (1, 'Astro Boy')" );
public affectedRows () inherited from Phalcon\Db\Adapter\Pdo Returns the number of affected rows by the latest INSERT/UPDATE/DELETE executed in the database system
$connection->execute( "DELETE FROM robots" );
echo $connection->affectedRows()," were deleted";
public close () inherited from Phalcon\Db\Adapter\Pdo Closes the active connection returning success. Phalcon automatically closes and destroys active connections when the request ends public escapeString (mixed $str) inherited from Phalcon\Db\Adapter\Pdo Escapes a value to avoid SQL injections according to the active charset in the connection
public convertBoundParams (mixed $sql, [array $params]) inherited from Phalcon\Db\Adapter\Pdo
2.5. API 633 Phalcon PHP Framework Documentation, Release 3.1.1
Converts bound parameters such as :name: or ?1 into PDO bind params ?
print_r( $connection->convertBoundParams( "SELECT * FROM robots WHERE name = :name:", [ "Bender", ] ) );
public int | boolean lastInsertId ([string $sequenceName]) inherited from Phalcon\Db\Adapter\Pdo Returns the insert id for the auto_increment/serial column inserted in the latest executed SQL statement
// Inserting a new robot $success= $connection->insert( "robots", [ "Astro Boy", 1952, ], [ "name", "year", ] );
// Getting the generated id $id= $connection->lastInsertId();
public begin ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Starts a transaction in the connection public rollback ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Rollbacks the active transaction in the connection public commit ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Commits the active transaction in the connection public getTransactionLevel () inherited from Phalcon\Db\Adapter\Pdo Returns the current transaction nesting level public isUnderTransaction () inherited from Phalcon\Db\Adapter\Pdo Checks whether the connection is under a transaction
public getInternalHandler () inherited from Phalcon\Db\Adapter\Pdo Return internal PDO handler public array getErrorInfo () inherited from Phalcon\Db\Adapter\Pdo Return the error info, if any public getDialectType () inherited from Phalcon\Db\Adapter Name of the dialect used public getType () inherited from Phalcon\Db\Adapter Type of database system the adapter is used for public getSqlVariables () inherited from Phalcon\Db\Adapter Active SQL bound parameter variables public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Db\Adapter Sets the event manager public getEventsManager () inherited from Phalcon\Db\Adapter Returns the internal event manager public setDialect (Phalcon\Db\DialectInterface $dialect) inherited from Phalcon\Db\Adapter Sets the dialect used to produce the SQL public getDialect () inherited from Phalcon\Db\Adapter Returns internal dialect instance public fetchOne (mixed $sqlQuery, [mixed $fetchMode], [mixed $bindParams], [mixed $bindTypes]) inherited from Phalcon\Db\Adapter Returns the first row in a SQL query result
// Getting first robot $robot= $connection->fetchOne("SELECT * FROM robots"); print_r($robot);
// Getting first robot with associative indexes only $robot= $connection->fetchOne("SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC); print_r($robot);
public array fetchAll (string $sqlQuery, [int $fetchMode], [array $bindParams], [array $bindTypes]) inherited from Phalcon\Db\Adapter Dumps the complete result of a query into an array
// Getting all robots with associative indexes only $robots= $connection->fetchAll( "SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC
2.5. API 635 Phalcon PHP Framework Documentation, Release 3.1.1
); foreach ($robots as $robot){ print_r($robot); }
// Getting all robots that contains word "robot" withing the name $robots= $connection->fetchAll( "SELECT * FROM robots WHERE name LIKE :name", \Phalcon\Db::FETCH_ASSOC, [ "name" =>"%robot%", ] ); foreach($robots as $robot){ print_r($robot); } public string | ** fetchColumn (string $sqlQuery, [array $placeholders], [int | string $column]) inherited from Phal- con\Db\Adapter Returns the n’th field of first row in a SQL query result
// Getting count of robots $robotsCount= $connection->fetchColumn("SELECT count( *) FROM robots"); print_r($robotsCount);
// Getting name of last edited robot $robot= $connection->fetchColumn( "SELECT id, name FROM robots order by modified desc", 1 ); print_r($robot); public boolean insert (string | array $table, array $values, [array $fields], [array $dataTypes]) inherited from Phal- con\Db\Adapter Inserts data into a table using custom RDBMS SQL syntax
// Inserting a new robot $success= $connection->insert( "robots", ["Astro Boy", 1952], ["name","year"] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean insertAsDict (string $table, array $data, [array $dataTypes]) inherited from Phalcon\Db\Adapter Inserts data into a table using custom RBDM SQL syntax
// Inserting a new robot $success= $connection->insertAsDict( "robots", [ "name" =>"Astro Boy", "year" => 1952, ] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean update (string | array $table, array $fields, array $values, [string | array $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
// Updating existing robot with array condition and $dataTypes $success= $connection->update( "robots", ["name"], ["New Astro Boy"], [ "conditions" =>"id = ?", "bind" =>[$some_unsafe_id], "bindTypes" => [PDO::PARAM_INT], // use only if you use $dataTypes param ], [ PDO::PARAM_STR ] );
Warning! If $whereCondition is string it not escaped. public boolean updateAsDict (string $table, array $data, [string $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax
2.5. API 637 Phalcon PHP Framework Documentation, Release 3.1.1
], "id = 101" );
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101 public boolean delete (string | array $table, [string $whereCondition], [array $placeholders], [array $dataTypes]) inherited from Phalcon\Db\Adapter Deletes data from a table using custom RBDM SQL syntax
// Next SQL sentence is generated DELETE FROM `robots` WHERE `id`= 101 public escapeIdentifier (array | string $identifier) inherited from Phalcon\Db\Adapter Escapes a column/table/schema name
$escapedTable= $connection->escapeIdentifier( [ "store", "robots", ] ); public string getColumnList (array $columnList) inherited from Phalcon\Db\Adapter Gets a list of columns public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Adapter Appends a LIMIT clause to $sqlQuery argument
limit("SELECT * FROM robots",5); public tableExists (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.table
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a FOR UPDATE clause public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a LOCK IN SHARE MODE clause public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a table from a schema/database public createView (mixed $viewName, array $definition, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Creates a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a view public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Adds a column to a table public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) inherited from Phal- con\Db\Adapter Drops a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phal- con\Db\Adapter Adds an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) inherited from Phal- con\Db\Adapter Drop an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phalcon\Db\Adapter Adds a primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) inherited from Phalcon\Db\Adapter Drops a table’s primary key public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) inher- ited from Phalcon\Db\Adapter Adds a foreign key to a table
2.5. API 639 Phalcon PHP Framework Documentation, Release 3.1.1
public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) inherited from Phal- con\Db\Adapter Drops a foreign key from a table public getColumnDefinition (Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Returns the SQL column definition from a column public listTables ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all tables on a database
print_r( $connection->listTables("blog") );
public listViews ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all views on a database
print_r( $connection->listViews("blog") );
public Phalcon\Db\Index[] describeIndexes (string $table, [string $schema]) inherited from Phalcon\Db\Adapter Lists table indexes
public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Releases given savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Rollbacks given savepoint public setNestedTransactionsWithSavepoints (mixed $nestedTransactionsWithSavepoints) inherited from Phal- con\Db\Adapter Set if nested transactions should use savepoints public isNestedTransactionsWithSavepoints () inherited from Phalcon\Db\Adapter Returns if nested transactions should use savepoints public getNestedTransactionSavepointName () inherited from Phalcon\Db\Adapter Returns the savepoint name to use for nested transactions public getDefaultValue () inherited from Phalcon\Db\Adapter Returns the default value to make the RBDM use the default value declared in the table definition
// Inserting a new robot with a valid default value for the column 'year' $success= $connection->insert( "robots", [ "Astro Boy", $connection->getDefaultValue() ], [ "name", "year", ] );
public getDescriptor () inherited from Phalcon\Db\Adapter Return descriptor used to connect to the active database public string getConnectionId () inherited from Phalcon\Db\Adapter Gets the active connection unique identifier public getSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object public getRealSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object without replace bound parameters public array getSQLBindTypes () inherited from Phalcon\Db\Adapter Active SQL statement in the object
Class Phalcon\Db\Adapter\Pdo\Sqlite extends abstract class Phalcon\Db\Adapter\Pdo implements Phalcon\Db\AdapterInterface, Phalcon\Events\EventsAwareInterface
2.5. API 641 Phalcon PHP Framework Documentation, Release 3.1.1
Specific functions for the Sqlite database system
use Phalcon\Db\Adapter\Pdo\Sqlite;
$connection= new Sqlite( [ "dbname" =>"/tmp/test.sqlite", ] );
Methods
public connect ([array $descriptor]) This method is automatically called in Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection. public describeColumns (mixed $table, [mixed $schema]) Returns an array of Phalcon\Db\Column objects describing a table
print_r( $connection->describeColumns("posts") );
public Phalcon\Db\IndexInterface[] describeIndexes (string $table, [string $schema]) Lists table indexes
public Phalcon\Db\ReferenceInterface[] describeReferences (string $table, [string $schema]) Lists table references public useExplicitIdValue () Check whether the database system requires an explicit value for identity columns public getDefaultValue () Returns the default value to make the RBDM use the default value declared in the table definition
// Inserting a new robot with a valid default value for the column 'year' $success= $connection->insert( "robots", [ "Astro Boy", $connection->getDefaultValue(), ],
[ "name", "year", ] ); public __construct (array $descriptor) inherited from Phalcon\Db\Adapter\Pdo Constructor for Phalcon\Db\Adapter\Pdo public prepare (mixed $sqlStatement) inherited from Phalcon\Db\Adapter\Pdo Returns a PDO prepared statement to be executed with ‘executePrepared’
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
$result= $connection->executePrepared( $statement, [ "name" =>"Voltron", ], [ "name" => Column::BIND_PARAM_INT, ] ); public PDOStatement executePrepared (PDOStatement $statement, array $placeholders, array $dataTypes) inherited from Phalcon\Db\Adapter\Pdo Executes a prepared statement binding. This function uses integer indexes starting from zero
$statement= $db->prepare( "SELECT * FROM robots WHERE name = :name" );
$result= $connection->executePrepared( $statement, [ "name" =>"Voltron", ], [ "name" => Column::BIND_PARAM_INT, ] ); public query (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server is returning rows
2.5. API 643 Phalcon PHP Framework Documentation, Release 3.1.1
// Querying data $resultset= $connection->query( "SELECT * FROM robots WHERE type = 'mechanical'" );
$resultset= $connection->query( "SELECT * FROM robots WHERE type = ?", [ "mechanical", ] );
public execute (mixed $sqlStatement, [mixed $bindParams], [mixed $bindTypes]) inherited from Phal- con\Db\Adapter\Pdo Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server doesn’t return any rows
// Inserting data $success= $connection->execute( "INSERT INTO robots VALUES (1, 'Astro Boy')" );
public affectedRows () inherited from Phalcon\Db\Adapter\Pdo Returns the number of affected rows by the latest INSERT/UPDATE/DELETE executed in the database system
$connection->execute( "DELETE FROM robots" );
echo $connection->affectedRows()," were deleted";
public close () inherited from Phalcon\Db\Adapter\Pdo Closes the active connection returning success. Phalcon automatically closes and destroys active connections when the request ends public escapeString (mixed $str) inherited from Phalcon\Db\Adapter\Pdo Escapes a value to avoid SQL injections according to the active charset in the connection
public convertBoundParams (mixed $sql, [array $params]) inherited from Phalcon\Db\Adapter\Pdo Converts bound parameters such as :name: or ?1 into PDO bind params ?
print_r( $connection->convertBoundParams( "SELECT * FROM robots WHERE name = :name:", [ "Bender", ] ) );
public int | boolean lastInsertId ([string $sequenceName]) inherited from Phalcon\Db\Adapter\Pdo Returns the insert id for the auto_increment/serial column inserted in the latest executed SQL statement
// Inserting a new robot $success= $connection->insert( "robots", [ "Astro Boy", 1952, ], [ "name", "year", ] );
// Getting the generated id $id= $connection->lastInsertId();
public begin ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Starts a transaction in the connection public rollback ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Rollbacks the active transaction in the connection public commit ([mixed $nesting]) inherited from Phalcon\Db\Adapter\Pdo Commits the active transaction in the connection public getTransactionLevel () inherited from Phalcon\Db\Adapter\Pdo Returns the current transaction nesting level public isUnderTransaction () inherited from Phalcon\Db\Adapter\Pdo Checks whether the connection is under a transaction
$connection->begin();
// true var_dump(
2.5. API 645 Phalcon PHP Framework Documentation, Release 3.1.1
$connection->isUnderTransaction() );
public getInternalHandler () inherited from Phalcon\Db\Adapter\Pdo Return internal PDO handler public array getErrorInfo () inherited from Phalcon\Db\Adapter\Pdo Return the error info, if any public getDialectType () inherited from Phalcon\Db\Adapter Name of the dialect used public getType () inherited from Phalcon\Db\Adapter Type of database system the adapter is used for public getSqlVariables () inherited from Phalcon\Db\Adapter Active SQL bound parameter variables public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Db\Adapter Sets the event manager public getEventsManager () inherited from Phalcon\Db\Adapter Returns the internal event manager public setDialect (Phalcon\Db\DialectInterface $dialect) inherited from Phalcon\Db\Adapter Sets the dialect used to produce the SQL public getDialect () inherited from Phalcon\Db\Adapter Returns internal dialect instance public fetchOne (mixed $sqlQuery, [mixed $fetchMode], [mixed $bindParams], [mixed $bindTypes]) inherited from Phalcon\Db\Adapter Returns the first row in a SQL query result
// Getting first robot $robot= $connection->fetchOne("SELECT * FROM robots"); print_r($robot);
// Getting first robot with associative indexes only $robot= $connection->fetchOne("SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC); print_r($robot);
public array fetchAll (string $sqlQuery, [int $fetchMode], [array $bindParams], [array $bindTypes]) inherited from Phalcon\Db\Adapter Dumps the complete result of a query into an array
// Getting all robots with associative indexes only $robots= $connection->fetchAll( "SELECT * FROM robots", \Phalcon\Db::FETCH_ASSOC
); foreach ($robots as $robot){ print_r($robot); }
// Getting all robots that contains word "robot" withing the name $robots= $connection->fetchAll( "SELECT * FROM robots WHERE name LIKE :name", \Phalcon\Db::FETCH_ASSOC, [ "name" =>"%robot%", ] ); foreach($robots as $robot){ print_r($robot); } public string | ** fetchColumn (string $sqlQuery, [array $placeholders], [int | string $column]) inherited from Phal- con\Db\Adapter Returns the n’th field of first row in a SQL query result
// Getting count of robots $robotsCount= $connection->fetchColumn("SELECT count( *) FROM robots"); print_r($robotsCount);
// Getting name of last edited robot $robot= $connection->fetchColumn( "SELECT id, name FROM robots order by modified desc", 1 ); print_r($robot); public boolean insert (string | array $table, array $values, [array $fields], [array $dataTypes]) inherited from Phal- con\Db\Adapter Inserts data into a table using custom RDBMS SQL syntax
// Inserting a new robot $success= $connection->insert( "robots", ["Astro Boy", 1952], ["name","year"] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean insertAsDict (string $table, array $data, [array $dataTypes]) inherited from Phalcon\Db\Adapter Inserts data into a table using custom RBDM SQL syntax
2.5. API 647 Phalcon PHP Framework Documentation, Release 3.1.1
// Inserting a new robot $success= $connection->insertAsDict( "robots", [ "name" =>"Astro Boy", "year" => 1952, ] );
// Next SQL sentence is sent to the database system INSERT INTO `robots`(`name`, `year`) VALUES ("Astro boy", 1952); public boolean update (string | array $table, array $fields, array $values, [string | array $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101
// Updating existing robot with array condition and $dataTypes $success= $connection->update( "robots", ["name"], ["New Astro Boy"], [ "conditions" =>"id = ?", "bind" =>[$some_unsafe_id], "bindTypes" => [PDO::PARAM_INT], // use only if you use $dataTypes param ], [ PDO::PARAM_STR ] );
Warning! If $whereCondition is string it not escaped. public boolean updateAsDict (string $table, array $data, [string $whereCondition], [array $dataTypes]) inherited from Phalcon\Db\Adapter Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax
// Next SQL sentence is sent to the database system UPDATE `robots` SET `name`="Astro boy" WHERE id= 101 public boolean delete (string | array $table, [string $whereCondition], [array $placeholders], [array $dataTypes]) inherited from Phalcon\Db\Adapter Deletes data from a table using custom RBDM SQL syntax
// Next SQL sentence is generated DELETE FROM `robots` WHERE `id`= 101 public escapeIdentifier (array | string $identifier) inherited from Phalcon\Db\Adapter Escapes a column/table/schema name
$escapedTable= $connection->escapeIdentifier( [ "store", "robots", ] ); public string getColumnList (array $columnList) inherited from Phalcon\Db\Adapter Gets a list of columns public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Adapter Appends a LIMIT clause to $sqlQuery argument
limit("SELECT * FROM robots",5); public tableExists (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.table
2.5. API 649 Phalcon PHP Framework Documentation, Release 3.1.1
$connection->tableExists("blog","posts") );
public viewExists (mixed $viewName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Generates SQL checking for the existence of a schema.view
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a FOR UPDATE clause public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Adapter Returns a SQL modified with a LOCK IN SHARE MODE clause public createTable (mixed $tableName, mixed $schemaName, array $definition) inherited from Phalcon\Db\Adapter Creates a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a table from a schema/database public createView (mixed $viewName, array $definition, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Creates a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) inherited from Phalcon\Db\Adapter Drops a view public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Adds a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) inherited from Phalcon\Db\Adapter Modifies a table column based on a definition public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) inherited from Phal- con\Db\Adapter Drops a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phal- con\Db\Adapter Adds an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) inherited from Phal- con\Db\Adapter Drop an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) inherited from Phalcon\Db\Adapter Adds a primary key to a table
public dropPrimaryKey (mixed $tableName, mixed $schemaName) inherited from Phalcon\Db\Adapter Drops a table’s primary key public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) inher- ited from Phalcon\Db\Adapter Adds a foreign key to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) inherited from Phal- con\Db\Adapter Drops a foreign key from a table public getColumnDefinition (Phalcon\Db\ColumnInterface $column) inherited from Phalcon\Db\Adapter Returns the SQL column definition from a column public listTables ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all tables on a database
print_r( $connection->listTables("blog") );
public listViews ([mixed $schemaName]) inherited from Phalcon\Db\Adapter List all views on a database
print_r( $connection->listViews("blog") );
public tableOptions (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\Adapter Gets creation options from a table
print_r( $connection->tableOptions("robots") );
public createSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Creates a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Releases given savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Adapter Rollbacks given savepoint public setNestedTransactionsWithSavepoints (mixed $nestedTransactionsWithSavepoints) inherited from Phal- con\Db\Adapter Set if nested transactions should use savepoints
2.5. API 651 Phalcon PHP Framework Documentation, Release 3.1.1
public isNestedTransactionsWithSavepoints () inherited from Phalcon\Db\Adapter Returns if nested transactions should use savepoints public getNestedTransactionSavepointName () inherited from Phalcon\Db\Adapter Returns the savepoint name to use for nested transactions public getDefaultIdValue () inherited from Phalcon\Db\Adapter Returns the default identity value to be inserted in an identity column
// Inserting a new robot with a valid default value for the column 'id' $success= $connection->insert( "robots", [ $connection->getDefaultIdValue(), "Astro Boy", 1952, ], [ "id", "name", "year", ] );
public supportSequences () inherited from Phalcon\Db\Adapter Check whether the database system requires a sequence to produce auto-numeric values public getDescriptor () inherited from Phalcon\Db\Adapter Return descriptor used to connect to the active database public string getConnectionId () inherited from Phalcon\Db\Adapter Gets the active connection unique identifier public getSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object public getRealSQLStatement () inherited from Phalcon\Db\Adapter Active SQL statement in the object without replace bound parameters public array getSQLBindTypes () inherited from Phalcon\Db\Adapter Active SQL statement in the object
Class Phalcon\Db\Column implements Phalcon\Db\ColumnInterface Allows to define columns to be used on create or alter table operations
Methods public getName () Column’s name public getSchemaName () Schema which table related is public getType () Column data type public getTypeReference () Column data type reference public getTypeValues () Column data type values public getSize () Integer column size public getScale () Integer column number scale public getDefault () Default column value public __construct (mixed $name, array $definition) Phalcon\Db\Column constructor public isUnsigned () Returns true if number column is unsigned public isNotNull () Not null public isPrimary () Column is part of the primary key? public isAutoIncrement () Auto-Increment public isNumeric () Check whether column have an numeric type public isFirst () Check whether column have first position in table public string getAfterPosition () Check whether field absolute to position in table public getBindType ()
Returns the type of bind handling public static __set_state (array $data) Restores the internal state of a Phalcon\Db\Column object public hasDefault () Check whether column has default value
Abstract class Phalcon\Db\Dialect implements Phalcon\Db\DialectInterface This is the base class to each database dialect. This implements common methods to transform intermediate code into its RDBMS related syntax
Methods public registerCustomFunction (mixed $name, mixed $customFunction) Registers custom SQL functions public getCustomFunctions () Returns registered functions final public escapeSchema (mixed $str, [mixed $escapeChar]) Escape Schema final public escape (mixed $str, [mixed $escapeChar]) Escape identifiers public limit (mixed $sqlQuery, mixed $number) Generates the SQL for LIMIT clause
$sql= $dialect->limit("SELECT * FROM robots", 10); echo $sql; // SELECT * FROM robots LIMIT 10
$sql= $dialect->limit("SELECT * FROM robots",[10, 50]); echo $sql; // SELECT * FROM robots LIMIT 10 OFFSET 50 public forUpdate (mixed $sqlQuery) Returns a SQL modified with a FOR UPDATE clause
$sql= $dialect->forUpdate("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots FOR UPDATE public sharedLock (mixed $sqlQuery) Returns a SQL modified with a LOCK IN SHARE MODE clause
2.5. API 655 Phalcon PHP Framework Documentation, Release 3.1.1
$sql= $dialect->sharedLock("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots LOCK IN SHARE MODE
final public getColumnList (array $columnList, [mixed $escapeChar], [mixed $bindCounts]) Gets a list of columns with escaped identifiers
getColumnList( [ "column1", "column", ] );
final public getSqlColumn (mixed $column, [mixed $escapeChar], [mixed $bindCounts]) Resolve Column expressions public getSqlExpression (array $expression, [mixed $escapeChar], [mixed $bindCounts]) Transforms an intermediate representation for an expression into a database system valid expression final public getSqlTable (mixed $table, [mixed $escapeChar]) Transform an intermediate representation of a schema/table into a database system valid expression public select (array $definition) Builds a SELECT statement public supportsSavepoints () Checks whether the platform supports savepoints public supportsReleaseSavepoints () Checks whether the platform supports releasing savepoints. public createSavepoint (mixed $name) Generate SQL to create a new savepoint public releaseSavepoint (mixed $name) Generate SQL to release a savepoint public rollbackSavepoint (mixed $name) Generate SQL to rollback a savepoint final protected getSqlExpressionScalar (array $expression, [mixed $escapeChar], [mixed $bindCounts]) Resolve Column expressions final protected getSqlExpressionObject (array $expression, [mixed $escapeChar], [mixed $bindCounts]) Resolve object expressions final protected getSqlExpressionQualified (array $expression, [mixed $escapeChar]) Resolve qualified expressions final protected getSqlExpressionBinaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts])
... abstract public tableExists (mixed $tableName, [mixed $schemaName]) inherited from Phalcon\Db\DialectInterface ... abstract public viewExists (mixed $viewName, [mixed $schemaName]) inherited from Phalcon\Db\DialectInterface ... abstract public describeColumns (mixed $table, [mixed $schema]) inherited from Phalcon\Db\DialectInterface ... abstract public listTables ([mixed $schemaName]) inherited from Phalcon\Db\DialectInterface ... abstract public describeIndexes (mixed $table, [mixed $schema]) inherited from Phalcon\Db\DialectInterface ... abstract public describeReferences (mixed $table, [mixed $schema]) inherited from Phalcon\Db\DialectInterface ... abstract public tableOptions (mixed $table, [mixed $schema]) inherited from Phalcon\Db\DialectInterface ...
Class Phalcon\Db\Dialect\Mysql extends abstract class Phalcon\Db\Dialect implements Phalcon\Db\DialectInterface Generates database specific SQL for the MySQL RDBMS
Methods public getColumnDefinition (Phalcon\Db\ColumnInterface $column) Gets the column name in MySQL public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) Generates SQL to add a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) Generates SQL to modify a column in a table public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) Generates SQL to delete a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Generates SQL to add an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) Generates SQL to delete an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index)
2.5. API 659 Phalcon PHP Framework Documentation, Release 3.1.1
Generates SQL to add the primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) Generates SQL to delete primary key from a table public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) Generates SQL to add an index to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) Generates SQL to delete a foreign key from a table public createTable (mixed $tableName, mixed $schemaName, array $definition) Generates SQL to create a table public truncateTable (mixed $tableName, mixed $schemaName) Generates SQL to truncate a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a table public createView (mixed $viewName, array $definition, [mixed $schemaName]) Generates SQL to create a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a view public tableExists (mixed $tableName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.table
tableExists("posts","blog"); echo $dialect->tableExists("posts"); public viewExists (mixed $viewName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.view public describeColumns (mixed $table, [mixed $schema]) Generates SQL describing a table
describeColumns("posts") ); public listTables ([mixed $schemaName]) List all tables in database
public listViews ([mixed $schemaName]) Generates the SQL to list all views of a schema or user public describeIndexes (mixed $table, [mixed $schema]) Generates SQL to query indexes on a table public describeReferences (mixed $table, [mixed $schema]) Generates SQL to query foreign keys on a table public tableOptions (mixed $table, [mixed $schema]) Generates the SQL to describe the table creation options protected _getTableOptions (array $definition) Generates SQL to add the table creation options public registerCustomFunction (mixed $name, mixed $customFunction) inherited from Phalcon\Db\Dialect Registers custom SQL functions public getCustomFunctions () inherited from Phalcon\Db\Dialect Returns registered functions final public escapeSchema (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape Schema final public escape (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape identifiers public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Dialect Generates the SQL for LIMIT clause
$sql= $dialect->limit("SELECT * FROM robots", 10); echo $sql; // SELECT * FROM robots LIMIT 10
$sql= $dialect->limit("SELECT * FROM robots",[10, 50]); echo $sql; // SELECT * FROM robots LIMIT 10 OFFSET 50
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a FOR UPDATE clause
$sql= $dialect->forUpdate("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots FOR UPDATE
public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a LOCK IN SHARE MODE clause
$sql= $dialect->sharedLock("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots LOCK IN SHARE MODE
2.5. API 661 Phalcon PHP Framework Documentation, Release 3.1.1
final public getColumnList (array $columnList, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Gets a list of columns with escaped identifiers
getColumnList( [ "column1", "column", ] );
final public getSqlColumn (mixed $column, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Resolve Column expressions public getSqlExpression (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Transforms an intermediate representation for an expression into a database system valid expression final public getSqlTable (mixed $table, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Transform an intermediate representation of a schema/table into a database system valid expression public select (array $definition) inherited from Phalcon\Db\Dialect Builds a SELECT statement public supportsSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports savepoints public supportsReleaseSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports releasing savepoints. public createSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to create a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to release a savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to rollback a savepoint final protected getSqlExpressionScalar (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Column expressions final protected getSqlExpressionObject (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve object expressions final protected getSqlExpressionQualified (array $expression, [mixed $escapeChar]) inherited from Phal- con\Db\Dialect
Resolve qualified expressions final protected getSqlExpressionBinaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve binary operations expressions final protected getSqlExpressionUnaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve unary operations expressions final protected getSqlExpressionFunctionCall (array $expression, mixed $escapeChar, [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve function calls final protected getSqlExpressionList (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Lists final protected getSqlExpressionAll (array $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve * final protected getSqlExpressionCastValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve CAST of values final protected getSqlExpressionConvertValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) in- herited from Phalcon\Db\Dialect Resolve CONVERT of values encodings final protected getSqlExpressionCase (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve CASE expressions final protected getSqlExpressionFrom (mixed $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve a FROM clause final protected getSqlExpressionJoins (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a JOINs clause final protected getSqlExpressionWhere (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a WHERE clause final protected getSqlExpressionGroupBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a GROUP BY clause final protected getSqlExpressionHaving (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a HAVING clause final protected getSqlExpressionOrderBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect
2.5. API 663 Phalcon PHP Framework Documentation, Release 3.1.1
Resolve an ORDER BY clause final protected getSqlExpressionLimit (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a LIMIT clause protected prepareColumnAlias (mixed $qualified, [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares column for this RDBMS protected prepareTable (mixed $table, [mixed $schema], [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares table for this RDBMS protected prepareQualified (mixed $column, [mixed $domain], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares qualified for this RDBMS
Class Phalcon\Db\Dialect\Postgresql extends abstract class Phalcon\Db\Dialect implements Phalcon\Db\DialectInterface Generates database specific SQL for the PostgreSQL RDBMS
Methods public getColumnDefinition (Phalcon\Db\ColumnInterface $column) Gets the column name in PostgreSQL public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) Generates SQL to add a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) Generates SQL to modify a column in a table public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) Generates SQL to delete a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Generates SQL to add an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) Generates SQL to delete an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Generates SQL to add the primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) Generates SQL to delete primary key from a table
public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference) Generates SQL to add an index to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) Generates SQL to delete a foreign key from a table public createTable (mixed $tableName, mixed $schemaName, array $definition) Generates SQL to create a table public truncateTable (mixed $tableName, mixed $schemaName) Generates SQL to truncate a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a table public createView (mixed $viewName, array $definition, [mixed $schemaName]) Generates SQL to create a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a view public tableExists (mixed $tableName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.table
echo $dialect->tableExists("posts","blog");
echo $dialect->tableExists("posts");
public viewExists (mixed $viewName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.view public describeColumns (mixed $table, [mixed $schema]) Generates SQL describing a table
print_r( $dialect->describeColumns("posts") );
public listTables ([mixed $schemaName]) List all tables in database
print_r( $dialect->listTables("blog") );
public string listViews ([string $schemaName]) Generates the SQL to list all views of a schema or user
2.5. API 665 Phalcon PHP Framework Documentation, Release 3.1.1
public describeIndexes (mixed $table, [mixed $schema]) Generates SQL to query indexes on a table public describeReferences (mixed $table, [mixed $schema]) Generates SQL to query foreign keys on a table public tableOptions (mixed $table, [mixed $schema]) Generates the SQL to describe the table creation options protected _castDefault (Phalcon\Db\ColumnInterface $column) ... protected _getTableOptions (array $definition) ... public registerCustomFunction (mixed $name, mixed $customFunction) inherited from Phalcon\Db\Dialect Registers custom SQL functions public getCustomFunctions () inherited from Phalcon\Db\Dialect Returns registered functions final public escapeSchema (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape Schema final public escape (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape identifiers public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Dialect Generates the SQL for LIMIT clause
$sql= $dialect->limit("SELECT * FROM robots", 10); echo $sql; // SELECT * FROM robots LIMIT 10
$sql= $dialect->limit("SELECT * FROM robots",[10, 50]); echo $sql; // SELECT * FROM robots LIMIT 10 OFFSET 50
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a FOR UPDATE clause
$sql= $dialect->forUpdate("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots FOR UPDATE
public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a LOCK IN SHARE MODE clause
$sql= $dialect->sharedLock("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots LOCK IN SHARE MODE
final public getColumnList (array $columnList, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Gets a list of columns with escaped identifiers
getColumnList( [ "column1", "column", ] );
final public getSqlColumn (mixed $column, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Resolve Column expressions public getSqlExpression (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Transforms an intermediate representation for an expression into a database system valid expression final public getSqlTable (mixed $table, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Transform an intermediate representation of a schema/table into a database system valid expression public select (array $definition) inherited from Phalcon\Db\Dialect Builds a SELECT statement public supportsSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports savepoints public supportsReleaseSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports releasing savepoints. public createSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to create a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to release a savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to rollback a savepoint final protected getSqlExpressionScalar (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Column expressions final protected getSqlExpressionObject (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve object expressions final protected getSqlExpressionQualified (array $expression, [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Resolve qualified expressions
2.5. API 667 Phalcon PHP Framework Documentation, Release 3.1.1
final protected getSqlExpressionBinaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve binary operations expressions final protected getSqlExpressionUnaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve unary operations expressions final protected getSqlExpressionFunctionCall (array $expression, mixed $escapeChar, [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve function calls final protected getSqlExpressionList (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Lists final protected getSqlExpressionAll (array $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve * final protected getSqlExpressionCastValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve CAST of values final protected getSqlExpressionConvertValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) in- herited from Phalcon\Db\Dialect Resolve CONVERT of values encodings final protected getSqlExpressionCase (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve CASE expressions final protected getSqlExpressionFrom (mixed $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve a FROM clause final protected getSqlExpressionJoins (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a JOINs clause final protected getSqlExpressionWhere (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a WHERE clause final protected getSqlExpressionGroupBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a GROUP BY clause final protected getSqlExpressionHaving (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a HAVING clause final protected getSqlExpressionOrderBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve an ORDER BY clause
final protected getSqlExpressionLimit (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a LIMIT clause protected prepareColumnAlias (mixed $qualified, [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares column for this RDBMS protected prepareTable (mixed $table, [mixed $schema], [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares table for this RDBMS protected prepareQualified (mixed $column, [mixed $domain], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares qualified for this RDBMS
Class Phalcon\Db\Dialect\Sqlite extends abstract class Phalcon\Db\Dialect implements Phalcon\Db\DialectInterface Generates database specific SQL for the Sqlite RDBMS
Methods public getColumnDefinition (Phalcon\Db\ColumnInterface $column) Gets the column name in SQLite public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) Generates SQL to add a column to a table public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phal- con\Db\ColumnInterface $currentColumn]) Generates SQL to modify a column in a table public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) Generates SQL to delete a column from a table public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Generates SQL to add an index to a table public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) Generates SQL to delete an index from a table public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) Generates SQL to add the primary key to a table public dropPrimaryKey (mixed $tableName, mixed $schemaName) Generates SQL to delete primary key from a table public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $reference)
2.5. API 669 Phalcon PHP Framework Documentation, Release 3.1.1
Generates SQL to add an index to a table public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) Generates SQL to delete a foreign key from a table public createTable (mixed $tableName, mixed $schemaName, array $definition) Generates SQL to create a table public truncateTable (mixed $tableName, mixed $schemaName) Generates SQL to truncate a table public dropTable (mixed $tableName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a table public createView (mixed $viewName, array $definition, [mixed $schemaName]) Generates SQL to create a view public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) Generates SQL to drop a view public tableExists (mixed $tableName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.table
tableExists("posts","blog"); echo $dialect->tableExists("posts"); public viewExists (mixed $viewName, [mixed $schemaName]) Generates SQL checking for the existence of a schema.view public describeColumns (mixed $table, [mixed $schema]) Generates SQL describing a table
describeColumns("posts") ); public listTables ([mixed $schemaName]) List all tables in database
listTables("blog") ); public listViews ([mixed $schemaName]) Generates the SQL to list all views of a schema or user public listIndexesSql (mixed $table, [mixed $schema], [mixed $keyName])
public describeIndexes (mixed $table, [mixed $schema]) Generates SQL to query indexes on a table public describeIndex (mixed $index) Generates SQL to query indexes detail on a table public describeReferences (mixed $table, [mixed $schema]) Generates SQL to query foreign keys on a table public tableOptions (mixed $table, [mixed $schema]) Generates the SQL to describe the table creation options public registerCustomFunction (mixed $name, mixed $customFunction) inherited from Phalcon\Db\Dialect Registers custom SQL functions public getCustomFunctions () inherited from Phalcon\Db\Dialect Returns registered functions final public escapeSchema (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape Schema final public escape (mixed $str, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Escape identifiers public limit (mixed $sqlQuery, mixed $number) inherited from Phalcon\Db\Dialect Generates the SQL for LIMIT clause
$sql= $dialect->limit("SELECT * FROM robots", 10); echo $sql; // SELECT * FROM robots LIMIT 10
$sql= $dialect->limit("SELECT * FROM robots",[10, 50]); echo $sql; // SELECT * FROM robots LIMIT 10 OFFSET 50
public forUpdate (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a FOR UPDATE clause
$sql= $dialect->forUpdate("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots FOR UPDATE
public sharedLock (mixed $sqlQuery) inherited from Phalcon\Db\Dialect Returns a SQL modified with a LOCK IN SHARE MODE clause
2.5. API 671 Phalcon PHP Framework Documentation, Release 3.1.1
$sql= $dialect->sharedLock("SELECT * FROM robots"); echo $sql; // SELECT * FROM robots LOCK IN SHARE MODE
final public getColumnList (array $columnList, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Gets a list of columns with escaped identifiers
getColumnList( [ "column1", "column", ] );
final public getSqlColumn (mixed $column, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Resolve Column expressions public getSqlExpression (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phal- con\Db\Dialect Transforms an intermediate representation for an expression into a database system valid expression final public getSqlTable (mixed $table, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Transform an intermediate representation of a schema/table into a database system valid expression public select (array $definition) inherited from Phalcon\Db\Dialect Builds a SELECT statement public supportsSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports savepoints public supportsReleaseSavepoints () inherited from Phalcon\Db\Dialect Checks whether the platform supports releasing savepoints. public createSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to create a new savepoint public releaseSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to release a savepoint public rollbackSavepoint (mixed $name) inherited from Phalcon\Db\Dialect Generate SQL to rollback a savepoint final protected getSqlExpressionScalar (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Column expressions final protected getSqlExpressionObject (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve object expressions
final protected getSqlExpressionQualified (array $expression, [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Resolve qualified expressions final protected getSqlExpressionBinaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve binary operations expressions final protected getSqlExpressionUnaryOperations (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve unary operations expressions final protected getSqlExpressionFunctionCall (array $expression, mixed $escapeChar, [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve function calls final protected getSqlExpressionList (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve Lists final protected getSqlExpressionAll (array $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve * final protected getSqlExpressionCastValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inher- ited from Phalcon\Db\Dialect Resolve CAST of values final protected getSqlExpressionConvertValue (array $expression, [mixed $escapeChar], [mixed $bindCounts]) in- herited from Phalcon\Db\Dialect Resolve CONVERT of values encodings final protected getSqlExpressionCase (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve CASE expressions final protected getSqlExpressionFrom (mixed $expression, [mixed $escapeChar]) inherited from Phalcon\Db\Dialect Resolve a FROM clause final protected getSqlExpressionJoins (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a JOINs clause final protected getSqlExpressionWhere (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a WHERE clause final protected getSqlExpressionGroupBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a GROUP BY clause final protected getSqlExpressionHaving (array $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a HAVING clause
2.5. API 673 Phalcon PHP Framework Documentation, Release 3.1.1
final protected getSqlExpressionOrderBy (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve an ORDER BY clause final protected getSqlExpressionLimit (mixed $expression, [mixed $escapeChar], [mixed $bindCounts]) inherited from Phalcon\Db\Dialect Resolve a LIMIT clause protected prepareColumnAlias (mixed $qualified, [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares column for this RDBMS protected prepareTable (mixed $table, [mixed $schema], [mixed $alias], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares table for this RDBMS protected prepareQualified (mixed $column, [mixed $domain], [mixed $escapeChar]) inherited from Phal- con\Db\Dialect Prepares qualified for this RDBMS
Class Phalcon\Db\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace
final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Db\Index implements Phalcon\Db\IndexInterface Allows to define indexes to be used on tables. Indexes are a common way to enhance database performance. An index allows the database server to find and retrieve specific rows much faster than it could do without an index
// Define new unique index $index_unique= new \Phalcon\Db\Index( 'column_UNIQUE', [ 'column', 'column' ], 'UNIQUE' );
// Define new primary index $index_primary= new \Phalcon\Db\Index( 'PRIMARY', [ 'column' ] );
// Add index to existing table $connection->addIndex("robots", null, $index_unique); $connection->addIndex("robots", null, $index_primary);
Methods public getName () Index name public getColumns () Index columns public getType () Index type public __construct (mixed $name, array $columns, [mixed $type]) Phalcon\Db\Index constructor
2.5. API 675 Phalcon PHP Framework Documentation, Release 3.1.1
public static __set_state (array $data) Restore a Phalcon\Db\Index object from export
Class Phalcon\Db\Profiler
Instances of Phalcon\Db can generate execution profiles on SQL statements sent to the relational database. Profiled information includes execution time in milliseconds. This helps you to identify bottlenecks in your applications.
$profiler= new \Phalcon\Db\Profiler();
// Set the connection profiler $connection->setProfiler($profiler);
$sql="SELECT buyer_name, quantity, product_name FROM buyers LEFT JOIN products ON buyers.pid=products.id";
// Execute a SQL statement $connection->query($sql);
// Get the last profile in the profiler $profile= $profiler->getLastProfile();
public Phalcon\Db\Profiler startProfile (string $sqlStatement, [mixed $sqlVariables], [mixed $sqlBindTypes]) Starts the profile of a SQL sentence public stopProfile () Stops the active profile public getNumberTotalStatements () Returns the total number of SQL statements processed public getTotalElapsedSeconds () Returns the total time in seconds spent by the profiles public getProfiles () Returns all the processed profiles public reset () Resets the profiler, cleaning up all the profiles public getLastProfile () Returns the last profile executed in the profiler
This class identifies each profile in a Phalcon\Db\Profiler
Methods public setSqlStatement (mixed $sqlStatement) SQL statement related to the profile public getSqlStatement () SQL statement related to the profile public setSqlVariables (array $sqlVariables) SQL variables related to the profile public getSqlVariables () SQL variables related to the profile public setSqlBindTypes (array $sqlBindTypes) SQL bind types related to the profile public getSqlBindTypes () SQL bind types related to the profile public setInitialTime (mixed $initialTime) Timestamp when the profile started public getInitialTime () Timestamp when the profile started public setFinalTime (mixed $finalTime) Timestamp when the profile ended public getFinalTime () Timestamp when the profile ended public getTotalElapsedSeconds () Returns the total time in seconds spent by the profile
Class Phalcon\Db\RawValue
This class allows to insert/update raw data without quoting or formatting. The next example shows how to use the MySQL now() function as a field value.
$subscriber= new Subscribers();
$subscriber->email="[email protected]"; $subscriber->createdAt= new \Phalcon\Db\RawValue("now()");
$subscriber->save();
2.5. API 677 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public getValue () Raw value without quoting or formatting public __toString () Raw value without quoting or formatting public __construct (mixed $value) Phalcon\Db\RawValue constructor
Class Phalcon\Db\Reference
implements Phalcon\Db\ReferenceInterface Allows to define reference constraints on tables
public getName () Constraint name public getSchemaName () ... public getReferencedSchema () ... public getReferencedTable () Referenced Table public getColumns () Local reference columns public getReferencedColumns ()
Referenced Columns public getOnDelete () ON DELETE public getOnUpdate () ON UPDATE public __construct (mixed $name, array $definition) Phalcon\Db\Reference constructor public static __set_state (array $data) Restore a Phalcon\Db\Reference object from export
Class Phalcon\Db\Result\Pdo
implements Phalcon\Db\ResultInterface Encapsulates the resultset internals
$result= $connection->query("SELECT * FROM robots ORDER BY name");
$result->setFetchMode( \Phalcon\Db::FETCH_NUM );
while ($robot= $result->fetchArray()) { print_r($robot); }
Methods
public __construct (Phalcon\Db\AdapterInterface $connection, PDOStatement $result, [string $sqlStatement], [array $bindParams], [array $bindTypes]) Phalcon\Db\Result\Pdo constructor public execute () Allows to execute the statement again. Some database systems don’t support scrollable cursors, So, as cursors are forward only, we need to execute the cursor again to fetch rows from the begining public fetch ([mixed $fetchStyle], [mixed $cursorOrientation], [mixed $cursorOffset]) Fetches an array/object of strings that corresponds to the fetched row, or FALSE if there are no more rows. This method is affected by the active fetch flag set using Phalcon\Db\Result\Pdo::setFetchMode
$result= $connection->query("SELECT * FROM robots ORDER BY name");
$result->setFetchMode( \Phalcon\Db::FETCH_OBJ );
2.5. API 679 Phalcon PHP Framework Documentation, Release 3.1.1
while ($robot= $result->fetch()) { echo $robot->name; } public fetchArray () Returns an array of strings that corresponds to the fetched row, or FALSE if there are no more rows. This method is affected by the active fetch flag set using Phalcon\Db\Result\Pdo::setFetchMode
$result= $connection->query("SELECT * FROM robots ORDER BY name");
$result->setFetchMode( \Phalcon\Db::FETCH_NUM ); while ($robot= result->fetchArray()) { print_r($robot); } public fetchAll ([mixed $fetchStyle], [mixed $fetchArgument], [mixed $ctorArgs]) Returns an array of arrays containing all the records in the result This method is affected by the active fetch flag set using Phalcon\Db\Result\Pdo::setFetchMode
$result= $connection->query( "SELECT * FROM robots ORDER BY name" );
$robots= $result->fetchAll(); public numRows () Gets number of rows returned by a resultset
$result= $connection->query( "SELECT * FROM robots ORDER BY name" ); echo "There are", $result->numRows()," rows in the resultset"; public dataSeek (mixed $number) Moves internal resultset cursor to another position letting us to fetch a certain row
$result= $connection->query( "SELECT * FROM robots ORDER BY name" );
// Move to third row on result $result->dataSeek(2);
// Fetch third row $row= $result->fetch(); public setFetchMode (mixed $fetchMode, [mixed $colNoOrClassNameOrObject], [mixed $ctorargs]) Changes the fetching mode affecting Phalcon\Db\Result\Pdo::fetch()
// Return array with integer indexes $result->setFetchMode( \Phalcon\Db::FETCH_NUM );
// Return associative array without integer indexes $result->setFetchMode( \Phalcon\Db::FETCH_ASSOC );
// Return associative array together with integer indexes $result->setFetchMode( \Phalcon\Db::FETCH_BOTH );
// Return an object $result->setFetchMode( \Phalcon\Db::FETCH_OBJ ); public getInternalResult () Gets the internal PDO result object
Class Phalcon\Debug
Provides debug capabilities to Phalcon applications
Methods public setUri (mixed $uri) Change the base URI for static resources public setShowBackTrace (mixed $showBackTrace) Sets if files the exception’s backtrace must be showed public setShowFiles (mixed $showFiles) Set if files part of the backtrace must be shown in the output public setShowFileFragment (mixed $showFileFragment) Sets if files must be completely opened and showed in the output or just the fragment related to the exception public listen ([mixed $exceptions], [mixed $lowSeverity]) Listen for uncaught exceptions and unsilent notices or warnings
2.5. API 681 Phalcon PHP Framework Documentation, Release 3.1.1
public listenExceptions () Listen for uncaught exceptions public listenLowSeverity () Listen for unsilent notices or warnings public halt () Halts the request showing a backtrace public debugVar (mixed $varz, [mixed $key]) Adds a variable to the debug output public clearVars () Clears are variables added previously protected _escapeString (mixed $value) Escapes a string with htmlentities protected _getArrayDump (array $argument, [mixed $n]) Produces a recursive representation of an array protected _getVarDump (mixed $variable) Produces an string representation of a variable public getMajorVersion () Returns the major framework’s version public getVersion () Generates a link to the current version documentation public getCssSources () Returns the css sources public getJsSources () Returns the javascript sources final protected showTraceItem (mixed $n, array $trace) Shows a backtrace item public onUncaughtLowSeverity (mixed $severity, mixed $message, mixed $file, mixed $line, mixed $context) Throws an exception when a notice or warning is raised public onUncaughtException (Exception $exception) Handles uncaught exceptions
echo (new \Phalcon\Debug\Dump())->variable($foo,"foo");
$foo="string"; $bar=["key" =>"value"]; $baz= new stdClass(); echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz);
Methods public getDetailed () ... public setDetailed (mixed $detailed) ... public __construct ([array $styles], [mixed $detailed]) Phalcon\Debug\Dump constructor public all () Alias of variables() method protected getStyle (mixed $type) Get style for type public setStyles ([array $styles]) Set styles for vars type public one (mixed $variable, [mixed $name]) Alias of variable() method protected output (mixed $variable, [mixed $name], [mixed $tab]) Prepare an HTML string of information about a single variable. public variable (mixed $variable, [mixed $name]) Returns an HTML string of information about a single variable.
variable($foo,"foo"); public variables () Returns an HTML string of debugging information about any number of variables, each wrapped in a “pre” tag.
$foo="string"; $bar=["key" =>"value"]; $baz= new stdClass();
2.5. API 683 Phalcon PHP Framework Documentation, Release 3.1.1
echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz); public toJson (mixed $variable) Returns an JSON string of information about a single variable.
$foo=[ "key" =>"value", ]; echo (new \Phalcon\Debug\Dump())->toJson($foo);
$foo= new stdClass(); $foo->bar="buz"; echo (new \Phalcon\Debug\Dump())->toJson($foo);
Class Phalcon\Debug\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception
Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Di
implements Phalcon\DiInterface, ArrayAccess Phalcon\Di is a component that implements Dependency Injection/Service Location of services and it’s itself a con- tainer for them. Since Phalcon is highly decoupled, Phalcon\Di is essential to integrate the different components of the framework. The developer can also use this component to inject dependencies and manage global instances of the different classes used in the application. Basically, this component implements the Inversion of Control pattern. Applying this, the objects do not receive their dependencies using setters or constructors, but requesting a service dependency injector. This reduces the overall complexity, since there is only one way to get the required dependencies within a component. Additionally, this pattern increases testability in the code, thus making it less prone to errors.
use Phalcon\Di; use Phalcon\Http\Request;
$di= new Di();
// Using a string definition $di->set("request", Request::class, true);
// Using an anonymous function $di->setShared( "request", function () { return new Request(); } );
$request= $di->getRequest();
Methods
public __construct () Phalcon\Di constructor public setInternalEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the internal event manager public getInternalEventsManager () Returns the internal event manager
2.5. API 685 Phalcon PHP Framework Documentation, Release 3.1.1 public set (mixed $name, mixed $definition, [mixed $shared]) Registers a service in the services container public setShared (mixed $name, mixed $definition) Registers an “always shared” service in the services container public remove (mixed $name) Removes a service in the services container It also removes any shared instance created for the service public attempt (mixed $name, mixed $definition, [mixed $shared]) Attempts to register a service in the services container Only is successful if a service hasn’t been registered previously with the same name public setRaw (mixed $name, Phalcon\Di\ServiceInterface $rawDefinition) Sets a service using a raw Phalcon\Di\Service definition public getRaw (mixed $name) Returns a service definition without resolving public getService (mixed $name) Returns a Phalcon\Di\Service instance public get (mixed $name, [mixed $parameters]) Resolves the service based on its configuration public mixed getShared (string $name, [array $parameters]) Resolves a service, the resolved service is stored in the DI, subsequent requests for this service will return the same instance public has (mixed $name) Check whether the DI contains a service by a name public wasFreshInstance () Check whether the last service obtained via getShared produced a fresh instance or an existing one public getServices () Return the services registered in the DI public offsetExists (mixed $name) Check if a service is registered using the array syntax public offsetSet (mixed $name, mixed $definition) Allows to register a shared service using the array syntax
$di["request"]= new \Phalcon\Http\Request(); public offsetGet (mixed $name) Allows to obtain a shared service using the array syntax
public offsetUnset (mixed $name) Removes a service from the services container using the array syntax public __call (mixed $method, [mixed $arguments]) Magic method to get or set services using setters/getters public static setDefault (Phalcon\DiInterface $dependencyInjector) Set a default dependency injection container to be obtained into static methods public static getDefault () Return the latest DI created public static reset () Resets the internal default DI
Class Phalcon\Di\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception
2.5. API 687 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Di\FactoryDefault
extends class Phalcon\Di implements ArrayAccess, Phalcon\DiInterface This is a variant of the standard Phalcon\Di. By default it automatically registers all the services provided by the framework. Thanks to this, the developer does not need to register each service individually providing a full stack framework
Methods public __construct () Phalcon\Di\FactoryDefault constructor public setInternalEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Di Sets the internal event manager public getInternalEventsManager () inherited from Phalcon\Di Returns the internal event manager public set (mixed $name, mixed $definition, [mixed $shared]) inherited from Phalcon\Di Registers a service in the services container public setShared (mixed $name, mixed $definition) inherited from Phalcon\Di Registers an “always shared” service in the services container public remove (mixed $name) inherited from Phalcon\Di Removes a service in the services container It also removes any shared instance created for the service public attempt (mixed $name, mixed $definition, [mixed $shared]) inherited from Phalcon\Di Attempts to register a service in the services container Only is successful if a service hasn’t been registered previously with the same name public setRaw (mixed $name, Phalcon\Di\ServiceInterface $rawDefinition) inherited from Phalcon\Di Sets a service using a raw Phalcon\Di\Service definition public getRaw (mixed $name) inherited from Phalcon\Di Returns a service definition without resolving public getService (mixed $name) inherited from Phalcon\Di Returns a Phalcon\Di\Service instance public get (mixed $name, [mixed $parameters]) inherited from Phalcon\Di Resolves the service based on its configuration public mixed getShared (string $name, [array $parameters]) inherited from Phalcon\Di
Resolves a service, the resolved service is stored in the DI, subsequent requests for this service will return the same instance public has (mixed $name) inherited from Phalcon\Di Check whether the DI contains a service by a name public wasFreshInstance () inherited from Phalcon\Di Check whether the last service obtained via getShared produced a fresh instance or an existing one public getServices () inherited from Phalcon\Di Return the services registered in the DI public offsetExists (mixed $name) inherited from Phalcon\Di Check if a service is registered using the array syntax public offsetSet (mixed $name, mixed $definition) inherited from Phalcon\Di Allows to register a shared service using the array syntax
$di["request"]= new \Phalcon\Http\Request(); public offsetGet (mixed $name) inherited from Phalcon\Di Allows to obtain a shared service using the array syntax
Class Phalcon\Di\FactoryDefault\Cli extends class Phalcon\Di\FactoryDefault implements Phalcon\DiInterface, ArrayAccess This is a variant of the standard Phalcon\Di. By default it automatically registers all the services provided by the framework. Thanks to this, the developer does not need to register each service individually. This class is specially suitable for CLI applications
2.5. API 689 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct () Phalcon\Di\FactoryDefault\Cli constructor public setInternalEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Di Sets the internal event manager public getInternalEventsManager () inherited from Phalcon\Di Returns the internal event manager public set (mixed $name, mixed $definition, [mixed $shared]) inherited from Phalcon\Di Registers a service in the services container public setShared (mixed $name, mixed $definition) inherited from Phalcon\Di Registers an “always shared” service in the services container public remove (mixed $name) inherited from Phalcon\Di Removes a service in the services container It also removes any shared instance created for the service public attempt (mixed $name, mixed $definition, [mixed $shared]) inherited from Phalcon\Di Attempts to register a service in the services container Only is successful if a service hasn’t been registered previously with the same name public setRaw (mixed $name, Phalcon\Di\ServiceInterface $rawDefinition) inherited from Phalcon\Di Sets a service using a raw Phalcon\Di\Service definition public getRaw (mixed $name) inherited from Phalcon\Di Returns a service definition without resolving public getService (mixed $name) inherited from Phalcon\Di Returns a Phalcon\Di\Service instance public get (mixed $name, [mixed $parameters]) inherited from Phalcon\Di Resolves the service based on its configuration public mixed getShared (string $name, [array $parameters]) inherited from Phalcon\Di Resolves a service, the resolved service is stored in the DI, subsequent requests for this service will return the same instance public has (mixed $name) inherited from Phalcon\Di Check whether the DI contains a service by a name public wasFreshInstance () inherited from Phalcon\Di Check whether the last service obtained via getShared produced a fresh instance or an existing one public getServices () inherited from Phalcon\Di Return the services registered in the DI public offsetExists (mixed $name) inherited from Phalcon\Di Check if a service is registered using the array syntax public offsetSet (mixed $name, mixed $definition) inherited from Phalcon\Di
Allows to register a shared service using the array syntax
$di["request"]= new \Phalcon\Http\Request(); public offsetGet (mixed $name) inherited from Phalcon\Di Allows to obtain a shared service using the array syntax
Abstract class Phalcon\Di\Injectable implements Phalcon\Di\InjectionAwareInterface, Phalcon\Events\EventsAwareInterface This class allows to access services in the services container by just only accessing a public property with the same name of a registered service
Methods public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the event manager public getEventsManager () Returns the internal event manager public __get (mixed $propertyName) Magic method __get
2.5. API 691 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Di\Service implements Phalcon\Di\ServiceInterface Represents individually a service in the services container
$service= new \Phalcon\Di\Service( "request", "Phalcon\\Http\\Request" );
$request= service->resolve();
Methods
final public __construct (string $name, mixed $definition, [boolean $shared]) public getName () Returns the service’s name public setShared (mixed $shared) Sets if the service is shared or not public isShared () Check whether the service is shared or not public setSharedInstance (mixed $sharedInstance) Sets/Resets the shared instance related to the service public setDefinition (mixed $definition) Set the service definition public mixed getDefinition () Returns the service definition public mixed resolve ([array $parameters], [Phalcon\DiInterface $dependencyInjector]) Resolves the service public setParameter (mixed $position, array $parameter) Changes a parameter in the definition without resolve the service public array getParameter (int $position) Returns a parameter in a specific position public isResolved () Returns true if the service was resolved public static __set_state (array $attributes) Restore the internal state of a service
This class builds instances based on complex definitions
Methods
private mixed _buildParameter (Phalcon\DiInterface $dependencyInjector, int $position, array $argument) Resolves a constructor/call parameter private _buildParameters (Phalcon\DiInterface $dependencyInjector, array $arguments) Resolves an array of parameters public mixed build (Phalcon\DiInterface $dependencyInjector, array $definition, [array $parameters]) Builds a service using a complex service definition
Abstract class Phalcon\Dispatcher
implements Phalcon\DispatcherInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Events\EventsAwareInterface This is the base class for Phalcon\Mvc\Dispatcher and Phalcon\Cli\Dispatcher. This class can’t be instantiated directly, you can use it to create your own dispatchers.
public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the events manager public getEventsManager () Returns the internal event manager public setActionSuffix (mixed $actionSuffix)
2.5. API 693 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the default action suffix public getActionSuffix () Gets the default action suffix public setModuleName (mixed $moduleName) Sets the module where the controller is (only informative) public getModuleName () Gets the module where the controller class is public setNamespaceName (mixed $namespaceName) Sets the namespace where the controller class is public getNamespaceName () Gets a namespace to be prepended to the current handler name public setDefaultNamespace (mixed $namespaceName) Sets the default namespace public getDefaultNamespace () Returns the default namespace public setDefaultAction (mixed $actionName) Sets the default action name public setActionName (mixed $actionName) Sets the action name to be dispatched public getActionName () Gets the latest dispatched action name public setParams (array $params) Sets action params to be dispatched public getParams () Gets action params public setParam (mixed $param, mixed $value) Set a param by its name or numeric index public mixed getParam (mixed $param, [string | array $filters], [mixed $defaultValue]) Gets a param by its name or numeric index public boolean hasParam (mixed $param) Check if a param exists public getActiveMethod () Returns the current method to be/executed in the dispatcher public isFinished () Checks if the dispatch loop is finished or has more pendent controllers/tasks to dispatch public setReturnedValue (mixed $value)
Sets the latest returned value by an action manually public mixed getReturnedValue () Returns value returned by the latest dispatched action public setModelBinding (mixed $value, [mixed $cache]) Enable/Disable model binding during dispatch
$di->set('dispatcher', function() { $dispatcher= new Dispatcher();
public getModelBinder () Gets model binder public object dispatch () Dispatches a handle action taking into account the routing parameters protected object _dispatch () Dispatches a handle action taking into account the routing parameters public forward (array $forward) Forwards the execution flow to another controller/action Dispatchers are unique per module. Forwarding between modules is not allowed
public wasForwarded () Check if the current executed action was forwarded by another one public getHandlerClass ()
2.5. API 695 Phalcon PHP Framework Documentation, Release 3.1.1
Possible class name that will be located to dispatch the request public callActionMethod (mixed $handler, mixed $actionMethod, [array $params]) ... public getBoundModels () Returns bound models from binder instance
dispatcher->getBoundModels(); // return array with $user } } protected _resolveEmptyProperties () Set empty properties to their defaults (where defaults are available)
Class Phalcon\Escaper implements Phalcon\EscaperInterface Escapes different kinds of text securing them. By using this component you may prevent XSS attacks. This component only works with UTF-8. The PREG extension needs to be compiled with UTF-8 support.
Methods public setEncoding (mixed $encoding) Sets the encoding to be used by the escaper
$escaper->setEncoding("utf-8"); public getEncoding () Returns the internal encoding used by the escaper public setHtmlQuoteType (mixed $quoteType) Sets the HTML quoting type for htmlspecialchars
$escaper->setHtmlQuoteType(ENT_XHTML); public setDoubleEncode (mixed $doubleEncode) Sets the double_encode to be used by the escaper
$escaper->setDoubleEncode(false);
final public detectEncoding (mixed $str) Detect the character encoding of a string to be handled by an encoder Special-handling for chr(172) and chr(128) to chr(159) which fail to be detected by mb_detect_encoding() final public normalizeEncoding (mixed $str) Utility to normalize a string’s encoding to UTF-32. public escapeHtml (mixed $text) Escapes a HTML string. Internally uses htmlspecialchars public escapeHtmlAttr (mixed $attribute) Escapes a HTML attribute string public escapeCss (mixed $css) Escape CSS strings by replacing non-alphanumeric chars by their hexadecimal escaped representation public escapeJs (mixed $js) Escape javascript strings by replacing non-alphanumeric chars by their hexadecimal escaped representation public escapeUrl (mixed $url) Escapes a URL. Internally uses rawurlencode
Class Phalcon\Escaper\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception
2.5. API 697 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Events\Event
implements Phalcon\Events\EventInterface This class offers contextual information of a fired event in the EventsManager
Methods
public getType () Event type public getSource () Event source public getData () Event data public __construct (string $type, object $source, [mixed $data], [boolean $cancelable]) Phalcon\Events\Event constructor public setData ([mixed $data]) Sets event data. public setType (mixed $type) Sets event type. public stop () Stops the event preventing propagation.
isCancelable()) { $event->stop(); } public isStopped () Check whether the event is currently stopped. public isCancelable () Check whether the event is cancelable.
isCancelable()) { $event->stop(); }
Class Phalcon\Events\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception
2.5. API 699 Phalcon PHP Framework Documentation, Release 3.1.1
final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Events\Manager
implements Phalcon\Events\ManagerInterface Phalcon Events Manager, offers an easy way to intercept and manipulate, if needed, the normal flow of operation. With the EventsManager the developer can create hooks or plugins that will offer monitoring of data, manipulation, conditional execution and much more.
Methods
public attach (string $eventType, object | callable $handler, [int $priority]) Attach a listener to the events manager public detach (string $eventType, object $handler) Detach the listener from the events manager public enablePriorities (mixed $enablePriorities) Set if priorities are enabled in the EventsManager public arePrioritiesEnabled () Returns if priorities are enabled public collectResponses (mixed $collect) Tells the event manager if it needs to collect all the responses returned by every registered listener in a single fire public isCollecting () Check if the events manager is collecting all all the responses returned by every registered listener in a single fire public array getResponses () Returns all the responses returned by every handler executed by the last ‘fire’ executed public detachAll ([mixed $type]) Removes all events from the EventsManager final public mixed fireQueue (SplPriorityQueue| array $queue, Phalcon\Events\Event $event) Internal handler to call a queue of events public mixed fire (string $eventType, object $source, [mixed $data], [boolean $cancelable]) Fires an event in the events manager causing the active listeners to be notified about it
$eventsManager->fire("db", $connection);
700 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public hasListeners (mixed $type) Check whether certain type of event has listeners public array getListeners (string $type) Returns all the attached listeners of a certain type
Class Phalcon\Exception extends class Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 701 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Filter
implements Phalcon\FilterInterface The Phalcon\Filter component provides a set of commonly needed data filters. It provides object oriented wrappers to the php filter extension. Also allows the developer to define his/her own filters
public add (mixed $name, mixed $handler) Adds a user-defined filter public sanitize (mixed $value, mixed $filters, [mixed $noRecursive]) Sanitizes a value with a specified single or set of filters protected _sanitize (mixed $value, mixed $filter) Internal sanitize wrapper to filter_var public getFilters () Return the user-defined filters in the instance
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Flash
implements Phalcon\FlashInterface, Phalcon\Di\InjectionAwareInterface Shows HTML notifications related to different circumstances. Classes can be stylized using CSS
$flash->success("The record was successfully deleted"); $flash->error("Cannot open the file");
2.5. API 703 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public __construct ([mixed $cssClasses]) Phalcon\Flash constructor public getAutoescape () Returns the autoescape mode in generated html public setAutoescape (mixed $autoescape) Set the autoescape mode in generated html public getEscaperService () Returns the Escaper Service public setEscaperService (Phalcon\EscaperInterface $escaperService) Sets the Escaper Service public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setImplicitFlush (mixed $implicitFlush) Set whether the output must be implicitly flushed to the output or returned as string public setAutomaticHtml (mixed $automaticHtml) Set if the output must be implicitly formatted with HTML public setCssClasses (array $cssClasses) Set an array with CSS classes to format the messages public error (mixed $message) Shows a HTML error message
$flash->error("This is an error");
public notice (mixed $message) Shows a HTML notice/information message
$flash->notice("This is an information");
public success (mixed $message) Shows a HTML success message
$flash->success("The process was finished successfully");
public warning (mixed $message) Shows a HTML warning message
$flash->warning("Hey, this is important");
public string | void outputMessage (mixed $type, string | array $message) Outputs a message formatting it with HTML
$flash->outputMessage("error", $message);
public clear () Clears accumulated messages when implicit flush is disabled abstract public message (mixed $type, mixed $message) inherited from Phalcon\FlashInterface ...
Class Phalcon\Flash\Direct
extends abstract class Phalcon\Flash implements Phalcon\Di\InjectionAwareInterface, Phalcon\FlashInterface This is a variant of the Phalcon\Flash that immediately outputs any message passed to it
Methods public message (mixed $type, mixed $message) Outputs a message public output ([mixed $remove]) Prints the messages accumulated in the flasher public __construct ([mixed $cssClasses]) inherited from Phalcon\Flash Phalcon\Flash constructor public getAutoescape () inherited from Phalcon\Flash Returns the autoescape mode in generated html public setAutoescape (mixed $autoescape) inherited from Phalcon\Flash Set the autoescape mode in generated html public getEscaperService () inherited from Phalcon\Flash Returns the Escaper Service public setEscaperService (Phalcon\EscaperInterface $escaperService) inherited from Phalcon\Flash Sets the Escaper Service public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Flash
2.5. API 705 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the dependency injector public getDI () inherited from Phalcon\Flash Returns the internal dependency injector public setImplicitFlush (mixed $implicitFlush) inherited from Phalcon\Flash Set whether the output must be implicitly flushed to the output or returned as string public setAutomaticHtml (mixed $automaticHtml) inherited from Phalcon\Flash Set if the output must be implicitly formatted with HTML public setCssClasses (array $cssClasses) inherited from Phalcon\Flash Set an array with CSS classes to format the messages public error (mixed $message) inherited from Phalcon\Flash Shows a HTML error message
$flash->error("This is an error");
public notice (mixed $message) inherited from Phalcon\Flash Shows a HTML notice/information message
$flash->notice("This is an information");
public success (mixed $message) inherited from Phalcon\Flash Shows a HTML success message
$flash->success("The process was finished successfully");
public warning (mixed $message) inherited from Phalcon\Flash Shows a HTML warning message
$flash->warning("Hey, this is important");
public string | void outputMessage (mixed $type, string | array $message) inherited from Phalcon\Flash Outputs a message formatting it with HTML
$flash->outputMessage("error", $message);
public clear () inherited from Phalcon\Flash Clears accumulated messages when implicit flush is disabled
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Flash\Session
extends abstract class Phalcon\Flash implements Phalcon\Di\InjectionAwareInterface, Phalcon\FlashInterface Temporarily stores the messages in session, then messages can be printed in the next request
2.5. API 707 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
protected _getSessionMessages (mixed $remove, [mixed $type]) Returns the messages stored in session protected _setSessionMessages (array $messages) Stores the messages in session public message (mixed $type, mixed $message) Adds a message to the session flasher public has ([mixed $type]) Checks whether there are messages public getMessages ([mixed $type], [mixed $remove]) Returns the messages in the session flasher public output ([mixed $remove]) Prints the messages in the session flasher public clear () Clear messages in the session messenger public __construct ([mixed $cssClasses]) inherited from Phalcon\Flash Phalcon\Flash constructor public getAutoescape () inherited from Phalcon\Flash Returns the autoescape mode in generated html public setAutoescape (mixed $autoescape) inherited from Phalcon\Flash Set the autoescape mode in generated html public getEscaperService () inherited from Phalcon\Flash Returns the Escaper Service public setEscaperService (Phalcon\EscaperInterface $escaperService) inherited from Phalcon\Flash Sets the Escaper Service public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Flash Sets the dependency injector public getDI () inherited from Phalcon\Flash Returns the internal dependency injector public setImplicitFlush (mixed $implicitFlush) inherited from Phalcon\Flash Set whether the output must be implicitly flushed to the output or returned as string public setAutomaticHtml (mixed $automaticHtml) inherited from Phalcon\Flash Set if the output must be implicitly formatted with HTML public setCssClasses (array $cssClasses) inherited from Phalcon\Flash Set an array with CSS classes to format the messages public error (mixed $message) inherited from Phalcon\Flash
$flash->error("This is an error"); public notice (mixed $message) inherited from Phalcon\Flash Shows a HTML notice/information message
$flash->notice("This is an information"); public success (mixed $message) inherited from Phalcon\Flash Shows a HTML success message
$flash->success("The process was finished successfully"); public warning (mixed $message) inherited from Phalcon\Flash Shows a HTML warning message
$flash->warning("Hey, this is important"); public string | void outputMessage (mixed $type, string | array $message) inherited from Phalcon\Flash Outputs a message formatting it with HTML
$flash->outputMessage("error", $message);
Abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface This is a base class for form elements
Methods public __construct (string $name, [array $attributes]) Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) Sets the parent form to the element public getForm () Returns the parent form to the element public setName (mixed $name)
2.5. API 709 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the element name public getName () Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) Sets the element filters public addFilter (mixed $filter) Adds a filter to current list of filters public mixed getFilters () Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) Adds a validator to the element public getValidators () Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) Returns the value of an attribute if present public setAttributes (array $attributes) Sets default attributes for the element public getAttributes () Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) Returns the value of an option if present public setUserOptions (array $options) Sets options for the element public getUserOptions () Returns the options for the element public setLabel (mixed $label) Sets the element label public getLabel ()
Returns the element label public label ([array $attributes]) Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () Returns the default value assigned to the element public getValue () Returns the element value public getMessages () Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) Appends a message to the internal message list public clear () Clears every element in the form to its default value public __toString () Magic method __toString renders the widget without attributes abstract public render ([mixed $attributes]) inherited from Phalcon\Forms\ElementInterface ...
Class Phalcon\Forms\Element\Check
extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=check] for forms
Methods
public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element
2.5. API 711 Phalcon PHP Framework Documentation, Release 3.1.1
public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element
public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Date extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=date] for forms
Methods public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element
2.5. API 713 Phalcon PHP Framework Documentation, Release 3.1.1
Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element
Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Email extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=email] for forms
2.5. API 715 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element
Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
2.5. API 717 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Forms\Element\File
extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=file] for forms
Methods
public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element
public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element
2.5. API 719 Phalcon PHP Framework Documentation, Release 3.1.1
Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Hidden
extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=hidden] for forms
Methods
public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element
Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element
2.5. API 721 Phalcon PHP Framework Documentation, Release 3.1.1
public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Numeric extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=number] for forms
Methods public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element
public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element
2.5. API 723 Phalcon PHP Framework Documentation, Release 3.1.1
Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Password extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=password] for forms
Methods public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element
Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value
2.5. API 725 Phalcon PHP Framework Documentation, Release 3.1.1
public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Radio extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=radio] for forms
Methods public render ([array $attributes]) Renders the element widget returning html public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element
Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element
2.5. API 727 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Select extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component SELECT (choice) for forms
Methods public __construct (string $name, [object | array $options], [array $attributes]) Phalcon\Forms\Element constructor public Phalcon\Forms\Element setOptions (array | object $options) Set the choice’s options public array | object getOptions () Returns the choices’ options public this addOption (array $option) Adds an option to the current options public render ([array $attributes]) Renders the element widget returning html public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element
728 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element
2.5. API 729 Phalcon PHP Framework Documentation, Release 3.1.1
public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Submit extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=submit] for forms
Methods public render ([array $attributes]) Renders the element widget public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element
Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element
2.5. API 731 Phalcon PHP Framework Documentation, Release 3.1.1
Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Element\Text extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component INPUT[type=text] for forms
public render ([array $attributes]) Renders the element widget public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element
2.5. API 733 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
extends abstract class Phalcon\Forms\Element implements Phalcon\Forms\ElementInterface Component TEXTAREA for forms
Methods
public render ([array $attributes]) Renders the element widget public __construct (string $name, [array $attributes]) inherited from Phalcon\Forms\Element Phalcon\Forms\Element constructor public setForm (Phalcon\Forms\Form $form) inherited from Phalcon\Forms\Element Sets the parent form to the element public getForm () inherited from Phalcon\Forms\Element Returns the parent form to the element public setName (mixed $name) inherited from Phalcon\Forms\Element Sets the element name public getName () inherited from Phalcon\Forms\Element Returns the element name public Phalcon\Forms\ElementInterface setFilters (array | string $filters) inherited from Phalcon\Forms\Element Sets the element filters public addFilter (mixed $filter) inherited from Phalcon\Forms\Element Adds a filter to current list of filters public mixed getFilters () inherited from Phalcon\Forms\Element Returns the element filters public Phalcon\Forms\ElementInterface addValidators (array $validators, [mixed $merge]) inherited from Phal- con\Forms\Element Adds a group of validators public addValidator (Phalcon\Validation\ValidatorInterface $validator) inherited from Phalcon\Forms\Element Adds a validator to the element public getValidators () inherited from Phalcon\Forms\Element Returns the validators registered for the element public prepareAttributes ([array $attributes], [mixed $useChecked]) inherited from Phalcon\Forms\Element Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value) inherited from Phal- con\Forms\Element Sets a default attribute for the element
2.5. API 735 Phalcon PHP Framework Documentation, Release 3.1.1
public mixed getAttribute (string $attribute, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an attribute if present public setAttributes (array $attributes) inherited from Phalcon\Forms\Element Sets default attributes for the element public getAttributes () inherited from Phalcon\Forms\Element Returns the default attributes for the element public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value) inherited from Phal- con\Forms\Element Sets an option for the element public mixed getUserOption (string $option, [mixed $defaultValue]) inherited from Phalcon\Forms\Element Returns the value of an option if present public setUserOptions (array $options) inherited from Phalcon\Forms\Element Sets options for the element public getUserOptions () inherited from Phalcon\Forms\Element Returns the options for the element public setLabel (mixed $label) inherited from Phalcon\Forms\Element Sets the element label public getLabel () inherited from Phalcon\Forms\Element Returns the element label public label ([array $attributes]) inherited from Phalcon\Forms\Element Generate the HTML to label the element public Phalcon\Forms\ElementInterface setDefault (mixed $value) inherited from Phalcon\Forms\Element Sets a default value in case the form does not use an entity or there is no value available for the element in _POST public getDefault () inherited from Phalcon\Forms\Element Returns the default value assigned to the element public getValue () inherited from Phalcon\Forms\Element Returns the element value public getMessages () inherited from Phalcon\Forms\Element Returns the messages that belongs to the element The element needs to be attached to a form public hasMessages () inherited from Phalcon\Forms\Element Checks whether there are messages attached to the element public setMessages (Phalcon\Validation\Message\Group $group) inherited from Phalcon\Forms\Element Sets the validation messages related to the element public appendMessage (Phalcon\Validation\MessageInterface $message) inherited from Phalcon\Forms\Element Appends a message to the internal message list public clear () inherited from Phalcon\Forms\Element
Clears every element in the form to its default value public __toString () inherited from Phalcon\Forms\Element Magic method __toString renders the widget without attributes
Class Phalcon\Forms\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 737 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Forms\Form extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Countable, Iterator, Traversable This component allows to build forms using an object-oriented interface
Methods public setValidation (mixed $validation) ... public getValidation () ... public __construct ([object $entity], [array $userOptions]) Phalcon\Forms\Form constructor public setAction (mixed $action) Sets the form’s action public getAction () Returns the form’s action public setUserOption (string $option, mixed $value) Sets an option for the form public getUserOption (string $option, [mixed $defaultValue]) Returns the value of an option if present public setUserOptions (array $options) Sets options for the element public getUserOptions () Returns the options for the element public setEntity (object $entity) Sets the entity related to the model public object getEntity () Returns the entity related to the model public getElements () Returns the form elements added to the form public bind (array $data, object $entity, [array $whitelist]) Binds data to the entity public isValid ([array $data], [object $entity]) Validates the form public getMessages ([mixed $byItemName])
Returns the messages generated in the validation public getMessagesFor (mixed $name) Returns the messages generated for a specific element public hasMessagesFor (mixed $name) Check if messages were generated for a specific element public add (Phalcon\Forms\ElementInterface $element, [mixed $position], [mixed $type]) Adds an element to the form public render (string $name, [array $attributes]) Renders a specific item in the form public get (mixed $name) Returns an element added to the form by its name public label (mixed $name, [array $attributes]) Generate the label of an element added to the form including HTML public getLabel (mixed $name) Returns a label for an element public getValue (mixed $name) Gets a value from the internal related entity or from the default value public has (mixed $name) Check if the form contains an element public remove (mixed $name) Removes an element from the form public clear ([array $fields]) Clears every element in the form to its default value public count () Returns the number of elements in the form public rewind () Rewinds the internal iterator public current () Returns the current element in the iterator public key () Returns the current position/key in the iterator public next () Moves the internal iteration pointer to the next position public valid () Check if the current element in the iterator is valid public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable
2.5. API 739 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Forms\Manager
Methods public create (string $name, [object $entity]) Creates a form registering it in the forms manager public get (mixed $name) Returns a form by its name public has (mixed $name) Checks if a form is registered in the forms manager public set (mixed $name, Phalcon\Forms\Form $form) Registers a form in the Forms Manager
Class Phalcon\Http\Cookie implements Phalcon\Http\CookieInterface, Phalcon\Di\InjectionAwareInterface Provide OO wrappers to manage a HTTP cookie
Methods public __construct (string $name, [mixed $value], [int $expire], [string $path], [boolean $secure], [string $domain], [boolean $httpOnly]) Phalcon\Http\Cookie constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public Phalcon\Http\Cookie setValue (string $value) Sets the cookie’s value
public mixed getValue ([string | array $filters], [string $defaultValue]) Returns the cookie’s value public send () Sends the cookie to the HTTP client Stores the cookie definition in session public restore () Reads the cookie-related info from the SESSION to restore the cookie as it was set This method is automatically called internally so normally you don’t need to call it public delete () Deletes the cookie by setting an expire time in the past public useEncryption (mixed $useEncryption) Sets if the cookie must be encrypted/decrypted automatically public isUsingEncryption () Check if the cookie is using implicit encryption public setExpiration (mixed $expire) Sets the cookie’s expiration time public getExpiration () Returns the current expiration time public setPath (mixed $path) Sets the cookie’s expiration time public getName () Returns the current cookie’s name public getPath () Returns the current cookie’s path public setDomain (mixed $domain) Sets the domain that the cookie is available to public getDomain () Returns the domain that the cookie is available to public setSecure (mixed $secure) Sets if the cookie must only be sent when the connection is secure (HTTPS) public getSecure () Returns whether the cookie must only be sent when the connection is secure (HTTPS) public setHttpOnly (mixed $httpOnly) Sets if the cookie is accessible only through the HTTP protocol public getHttpOnly () Returns if the cookie is accessible only through the HTTP protocol public __toString ()
2.5. API 741 Phalcon PHP Framework Documentation, Release 3.1.1
Magic __toString method converts the cookie’s value to string
Class Phalcon\Http\Cookie\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Http\Request
implements Phalcon\Http\RequestInterface, Phalcon\Di\InjectionAwareInterface Encapsulates request information for easy and secure access from application controllers. The request object is a simple value object that is passed between the dispatcher and controller classes. It packages the HTTP request environment.
$request= new Request(); if ($request->isPost()&& $request->isAjax()) { echo "Request was made using POST and AJAX"; }
$request->getServer("HTTP_HOST"); // Retrieve SERVER variables $request->getMethod(); // GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH,
˓→PURGE, TRACE, CONNECT $request->getLanguages(); // An array of languages the client accepts
Methods public getHttpMethodParameterOverride () ... public setHttpMethodParameterOverride (mixed $httpMethodParameterOverride) ... public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public get ([mixed $name], [mixed $filters], [mixed $defaultValue], [mixed $notAllowEmpty], [mixed $noRecursive]) Gets a variable from the $_REQUEST superglobal applying filters if needed. If no parameters are given the $_RE- QUEST superglobal is returned
// Returns value from $_REQUEST["user_email"] without sanitizing $userEmail= $request->get("user_email");
// Returns value from $_REQUEST["user_email"] with sanitizing $userEmail= $request->get("user_email","email"); public getPost ([mixed $name], [mixed $filters], [mixed $defaultValue], [mixed $notAllowEmpty], [mixed $noRecur- sive]) Gets a variable from the $_POST superglobal applying filters if needed If no parameters are given the $_POST super- global is returned
// Returns value from $_POST["user_email"] without sanitizing $userEmail= $request->getPost("user_email");
// Returns value from $_POST["user_email"] with sanitizing $userEmail= $request->getPost("user_email","email");
2.5. API 743 Phalcon PHP Framework Documentation, Release 3.1.1
public getPut ([mixed $name], [mixed $filters], [mixed $defaultValue], [mixed $notAllowEmpty], [mixed $noRecur- sive]) Gets a variable from put request
// Returns value from $_PUT["user_email"] without sanitizing $userEmail= $request->getPut("user_email");
// Returns value from $_PUT["user_email"] with sanitizing $userEmail= $request->getPut("user_email","email");
public getQuery ([mixed $name], [mixed $filters], [mixed $defaultValue], [mixed $notAllowEmpty], [mixed $noRe- cursive]) Gets variable from $_GET superglobal applying filters if needed If no parameters are given the $_GET superglobal is returned
// Returns value from $_GET["id"] without sanitizing $id= $request->getQuery("id");
// Returns value from $_GET["id"] with sanitizing $id= $request->getQuery("id","int");
// Returns value from $_GET["id"] with a default value $id= $request->getQuery("id", null, 150);
final protected getHelper (array $source, [mixed $name], [mixed $filters], [mixed $defaultValue], [mixed $notAl- lowEmpty], [mixed $noRecursive]) Helper to get data from superglobals, applying filters if needed. If no parameters are given the superglobal is returned. public getServer (mixed $name) Gets variable from $_SERVER superglobal public has (mixed $name) Checks whether $_REQUEST superglobal has certain index public hasPost (mixed $name) Checks whether $_POST superglobal has certain index public hasPut (mixed $name) Checks whether the PUT data has certain index public hasQuery (mixed $name) Checks whether $_GET superglobal has certain index final public hasServer (mixed $name) Checks whether $_SERVER superglobal has certain index final public getHeader (mixed $header) Gets HTTP header from request data public getScheme ()
Gets HTTP schema (http/https) public isAjax () Checks whether request has been made using ajax public isSoap () Checks whether request has been made using SOAP public isSoapRequested () Alias of isSoap(). It will be deprecated in future versions public isSecure () Checks whether request has been made using any secure layer public isSecureRequest () Alias of isSecure(). It will be deprecated in future versions public getRawBody () Gets HTTP raw request body public getJsonRawBody ([mixed $associative]) Gets decoded JSON HTTP raw request body public getServerAddress () Gets active server address IP public getServerName () Gets active server name public getHttpHost () Gets host name used by the request. Request::getHttpHost trying to find host name in following order: - $_SERVER[”HTTP_HOST”] - $_SERVER[”SERVER_NAME”] - $_SERVER[”SERVER_ADDR”] Optionally Re- quest::getHttpHost validates and clean host name. The Request::$_strictHostCheck can be used to validate host name. Note: validation and cleaning have a negative performance impact because they use regular expressions.
2.5. API 745 Phalcon PHP Framework Documentation, Release 3.1.1
public setStrictHostCheck ([mixed $flag]) Sets if the Request::getHttpHost method must be use strict validation of host name or not public isStrictHostCheck () Checks if the Request::getHttpHost method will be use strict validation of host name or not public getPort () Gets information about the port on which the request is made. final public getURI () Gets HTTP URI which request has been made public getClientAddress ([mixed $trustForwardedHeader]) Gets most possible client IPv4 Address. This method searches in $_SERVER[”REMOTE_ADDR”] and optionally in $_SERVER[”HTTP_X_FORWARDED_FOR”] final public getMethod () Gets HTTP method which request has been made If the X-HTTP-Method-Override header is set, and if the method is a POST, then it is used to determine the “real” intended HTTP method. The _method request parameter can also be used to determine the HTTP method, but only if setHttpMethodParameterOverride(true) has been called. The method is always an uppercased string. public getUserAgent () Gets HTTP user agent used to made the request public isValidHttpMethod (mixed $method) Checks if a method is a valid HTTP method public isMethod (mixed $methods, [mixed $strict]) Check if HTTP method match any of the passed methods When strict is true it checks if validated methods are real HTTP methods public isPost () Checks whether HTTP method is POST. if _SERVER[”REQUEST_METHOD”]===”POST” public isGet () Checks whether HTTP method is GET. if _SERVER[”REQUEST_METHOD”]===”GET” public isPut () Checks whether HTTP method is PUT. if _SERVER[”REQUEST_METHOD”]===”PUT” public isPatch () Checks whether HTTP method is PATCH. if _SERVER[”REQUEST_METHOD”]===”PATCH” public isHead () Checks whether HTTP method is HEAD. if _SERVER[”REQUEST_METHOD”]===”HEAD” public isDelete () Checks whether HTTP method is DELETE. if _SERVER[”REQUEST_METHOD”]===”DELETE” public isOptions () Checks whether HTTP method is OPTIONS. if _SERVER[”REQUEST_METHOD”]===”OPTIONS” public isPurge ()
Checks whether HTTP method is PURGE (Squid and Varnish support). if _SERVER[”REQUEST_METHOD”]===”PURGE” public isTrace () Checks whether HTTP method is TRACE. if _SERVER[”REQUEST_METHOD”]===”TRACE” public isConnect () Checks whether HTTP method is CONNECT. if _SERVER[”REQUEST_METHOD”]===”CONNECT” public hasFiles ([mixed $onlySuccessful]) Checks whether request include attached files final protected hasFileHelper (mixed $data, mixed $onlySuccessful) Recursively counts file in an array of files public getUploadedFiles ([mixed $onlySuccessful]) Gets attached files as Phalcon\Http\Request\File instances final protected smoothFiles (array $names, array $types, array $tmp_names, array $sizes, array $errors, mixed $prefix) Smooth out $_FILES to have plain array with all files uploaded public getHeaders () Returns the available headers in the request
public getHTTPReferer () Gets web page that refers active request. ie: http://www.google.com final protected _getBestQuality (array $qualityParts, mixed $name) Process a request header and return the one with best quality public getContentType () Gets content type which request has been made public getAcceptableContent () Gets an array with mime/types and their quality accepted by the browser/client from _SERVER[”HTTP_ACCEPT”] public getBestAccept () Gets best mime/type accepted by the browser/client from _SERVER[”HTTP_ACCEPT”] public getClientCharsets () Gets a charsets array and their quality accepted by the browser/client from _SERVER[”HTTP_ACCEPT_CHARSET”] public getBestCharset ()
2.5. API 747 Phalcon PHP Framework Documentation, Release 3.1.1
Gets best charset accepted by the browser/client from _SERVER[”HTTP_ACCEPT_CHARSET”] public getLanguages () Gets languages array and their quality accepted by the browser/client from _SERVER[”HTTP_ACCEPT_LANGUAGE”] public getBestLanguage () Gets best language accepted by the browser/client from _SERVER[”HTTP_ACCEPT_LANGUAGE”] public getBasicAuth () Gets auth info accepted by the browser/client from $_SERVER[”PHP_AUTH_USER”] public getDigestAuth () Gets auth info accepted by the browser/client from $_SERVER[”PHP_AUTH_DIGEST”] final protected _getQualityHeader (mixed $serverIndex, mixed $name) Process a request header and return an array of values with their qualities
Class Phalcon\Http\Request\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception
final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Http\Request\File implements Phalcon\Http\Request\FileInterface Provides OO wrappers to the $_FILES superglobal
request->hasFiles() == true){ // Print the real file names and their sizes foreach ($this->request->getUploadedFiles() as $file){ echo $file->getName(),"", $file->getSize()," \n"; } } } }
Methods public getError () public getKey () public getExtension () public __construct (array $file, [mixed $key]) Phalcon\Http\Request\File constructor public getSize () Returns the file size of the uploaded file public getName () Returns the real name of the uploaded file public getTempName () Returns the temporary name of the uploaded file public getType () Returns the mime type reported by the browser This mime type is not completely secure, use getRealType() instead public getRealType ()
2.5. API 749 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the real mime type of the upload file using finfo public isUploadedFile () Checks whether the file has been uploaded via Post. public moveTo (mixed $destination) Moves the temporary file to a destination within the application
Class Phalcon\Http\Response
implements Phalcon\Http\ResponseInterface, Phalcon\Di\InjectionAwareInterface Part of the HTTP cycle is return responses to the clients. Phalcon\HTTP\Response is the Phalcon component respon- sible to achieve this task. HTTP responses are usually composed by headers and body.
public setHeaders (Phalcon\Http\Response\HeadersInterface $headers) Sets a headers bag for the response externally public getHeaders () Returns headers set by the user public setCookies (Phalcon\Http\Response\CookiesInterface $cookies) Sets a cookies bag for the response externally public Phalcon\Http\Response\CookiesInterface getCookies () Returns cookies set by the user public setHeader (mixed $name, mixed $value) Overwrites a header in the response
public setRawHeader (mixed $header) Send a raw header to the response
$response->setRawHeader("HTTP/1.1 404 Not Found");
public resetHeaders () Resets all the established headers public setExpires (DateTime $datetime) Sets an Expires header in the response that allows to use the HTTP cache
$this->response->setExpires( new DateTime() );
public setLastModified (DateTime $datetime) Sets Last-Modified header
$this->response->setLastModified( new DateTime() );
public setCache (mixed $minutes) Sets Cache headers to use HTTP cache
$this->response->setCache(60);
2.5. API 751 Phalcon PHP Framework Documentation, Release 3.1.1 public setNotModified () Sends a Not-Modified response public setContentType (mixed $contentType, [mixed $charset]) Sets the response content-type mime, optionally the charset
$response->setContentType("application/pdf"); $response->setContentType("text/plain","UTF-8"); public setContentLength (mixed $contentLength) Sets the response content-length
$response->setContentLength(2048); public setEtag (mixed $etag) Set a custom ETag
$response->setEtag(md5(time())); public redirect ([mixed $location], [mixed $externalRedirect], [mixed $statusCode]) Redirect by HTTP to another action or URL
// Using a string redirect (internal/external) $response->redirect("posts/index"); $response->redirect("http://en.wikipedia.org", true); $response->redirect("http://www.example.com/new-location", true, 301);
// Making a redirection based on a named route $response->redirect( [ "for" =>"index-lang", "lang" =>"jp", "controller" =>"index", ] ); public setContent (mixed $content) Sets HTTP response body
$response->setContent("
Hello!
"); public setJsonContent (mixed $content, [mixed $jsonOptions], [mixed $depth]) Sets HTTP response body. The parameter is automatically converted to JSON and also sets default header: Content- Type: “application/json; charset=UTF-8”
$response->setJsonContent( [ "status" =>"OK", ] ); public appendContent (mixed $content) Appends a string to the HTTP response body public getContent () Gets the HTTP response body public isSent () Check if the response is already sent public sendHeaders () Sends headers to the client public sendCookies () Sends cookies to the client public send () Prints out HTTP response to the client public setFileToSend (mixed $filePath, [mixed $attachmentName], [mixed $attachment]) Sets an attached file to be sent at the end of the request
Class Phalcon\Http\Response\Cookies implements Phalcon\Http\Response\CookiesInterface, Phalcon\Di\InjectionAwareInterface This class is a bag to manage the cookies A cookies bag is automatically registered as part of the ‘response’ service in the DI
Methods public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public useEncryption (mixed $useEncryption) Set if cookies in the bag must be automatically encrypted/decrypted public isUsingEncryption () Returns if the bag is automatically encrypting/decrypting cookies public set (mixed $name, [mixed $value], [mixed $expire], [mixed $path], [mixed $secure], [mixed $domain], [mixed $httpOnly])
2.5. API 753 Phalcon PHP Framework Documentation, Release 3.1.1
Sets a cookie to be sent at the end of the request This method overrides any cookie set before with the same name public get (mixed $name) Gets a cookie from the bag public has (mixed $name) Check if a cookie is defined in the bag or exists in the _COOKIE superglobal public delete (mixed $name) Deletes a cookie by its name This method does not removes cookies from the _COOKIE superglobal public send () Sends the cookies to the client Cookies aren’t sent if headers are sent in the current request public reset () Reset set cookies
Class Phalcon\Http\Response\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception
Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Http\Response\Headers implements Phalcon\Http\Response\HeadersInterface This class is a bag to manage the response headers
Methods public set (mixed $name, mixed $value) Sets a header to be sent at the end of the request public get (mixed $name) Gets a header value from the internal bag public setRaw (mixed $header) Sets a raw header to be sent at the end of the request public remove (mixed $header) Removes a header to be sent at the end of the request public send () Sends the headers to the client public reset () Reset set headers public toArray () Returns the current headers as an array public static __set_state (array $data) Restore a \Phalcon\Http\Response\Headers object
Abstract class Phalcon\Image\Adapter implements Phalcon\Image\AdapterInterface All image adapters must use this class
Methods public getImage () ... public getRealpath () ... public getWidth () Image width public getHeight () Image height public getType () Image type Driver dependent public getMime () Image mime type public resize ([mixed $width], [mixed $height], [mixed $master]) Resize the image to the given size public liquidRescale (mixed $width, mixed $height, [mixed $deltaX], [mixed $rigidity]) This method scales the images using liquid rescaling method. Only support Imagick public crop (mixed $width, mixed $height, [mixed $offsetX], [mixed $offsetY]) Crop an image to the given size public rotate (mixed $degrees) Rotate the image by a given amount public flip (mixed $direction) Flip the image along the horizontal or vertical axis public sharpen (mixed $amount) Sharpen the image by a given amount public reflection (mixed $height, [mixed $opacity], [mixed $fadeIn]) Add a reflection to an image public watermark (Phalcon\Image\Adapter $watermark, [mixed $offsetX], [mixed $offsetY], [mixed $opacity]) Add a watermark to an image with the specified opacity
public text (mixed $text, [mixed $offsetX], [mixed $offsetY], [mixed $opacity], [mixed $color], [mixed $size], [mixed $fontfile]) Add a text to an image with a specified opacity public mask (Phalcon\Image\Adapter $watermark) Composite one image onto another public background (mixed $color, [mixed $opacity]) Set the background color of an image public blur (mixed $radius) Blur image public pixelate (mixed $amount) Pixelate image public save ([mixed $file], [mixed $quality]) Save the image public render ([mixed $ext], [mixed $quality]) Render the image and return the binary string
Class Phalcon\Image\Adapter\Gd
extends abstract class Phalcon\Image\Adapter implements Phalcon\Image\AdapterInterface
public liquidRescale (mixed $width, mixed $height, [mixed $deltaX], [mixed $rigidity]) inherited from Phal- con\Image\Adapter This method scales the images using liquid rescaling method. Only support Imagick public crop (mixed $width, mixed $height, [mixed $offsetX], [mixed $offsetY]) inherited from Phalcon\Image\Adapter Crop an image to the given size public rotate (mixed $degrees) inherited from Phalcon\Image\Adapter Rotate the image by a given amount public flip (mixed $direction) inherited from Phalcon\Image\Adapter Flip the image along the horizontal or vertical axis public sharpen (mixed $amount) inherited from Phalcon\Image\Adapter Sharpen the image by a given amount public reflection (mixed $height, [mixed $opacity], [mixed $fadeIn]) inherited from Phalcon\Image\Adapter Add a reflection to an image public watermark (Phalcon\Image\Adapter $watermark, [mixed $offsetX], [mixed $offsetY], [mixed $opacity]) in- herited from Phalcon\Image\Adapter Add a watermark to an image with the specified opacity public text (mixed $text, [mixed $offsetX], [mixed $offsetY], [mixed $opacity], [mixed $color], [mixed $size], [mixed $fontfile]) inherited from Phalcon\Image\Adapter Add a text to an image with a specified opacity public mask (Phalcon\Image\Adapter $watermark) inherited from Phalcon\Image\Adapter Composite one image onto another public background (mixed $color, [mixed $opacity]) inherited from Phalcon\Image\Adapter Set the background color of an image public blur (mixed $radius) inherited from Phalcon\Image\Adapter Blur image public pixelate (mixed $amount) inherited from Phalcon\Image\Adapter Pixelate image public save ([mixed $file], [mixed $quality]) inherited from Phalcon\Image\Adapter Save the image public render ([mixed $ext], [mixed $quality]) inherited from Phalcon\Image\Adapter Render the image and return the binary string
Class Phalcon\Image\Adapter\Imagick extends abstract class Phalcon\Image\Adapter implements Phalcon\Image\AdapterInterface Image manipulation support. Allows images to be resized, cropped, etc.
2.5. API 759 Phalcon PHP Framework Documentation, Release 3.1.1
$image= new \Phalcon\Image\Adapter\Imagick("upload/test.jpg");
$image->resize(200, 200)->rotate(90)->crop(100, 100); if ($image->save()) { echo "success"; }
Methods public static check () Checks if Imagick is enabled public __construct (mixed $file, [mixed $width], [mixed $height]) \Phalcon\Image\Adapter\Imagick constructor protected _resize (mixed $width, mixed $height) Execute a resize. protected _liquidRescale (mixed $width, mixed $height, mixed $deltaX, mixed $rigidity) This method scales the images using liquid rescaling method. Only support Imagick protected _crop (mixed $width, mixed $height, mixed $offsetX, mixed $offsetY) Execute a crop. protected _rotate (mixed $degrees) Execute a rotation. protected _flip (mixed $direction) Execute a flip. protected _sharpen (mixed $amount) Execute a sharpen. protected _reflection (mixed $height, mixed $opacity, mixed $fadeIn) Execute a reflection. protected _watermark (Phalcon\Image\Adapter $image, mixed $offsetX, mixed $offsetY, mixed $opacity) Execute a watermarking. protected _text (mixed $text, mixed $offsetX, mixed $offsetY, mixed $opacity, mixed $r, mixed $g, mixed $b, mixed $size, mixed $fontfile) Execute a text protected _mask (Phalcon\Image\Adapter $image) Composite one image onto another protected _background (mixed $r, mixed $g, mixed $b, mixed $opacity) Execute a background. protected _blur (mixed $radius)
Blur image protected _pixelate (mixed $amount) Pixelate image protected _save (mixed $file, mixed $quality) Execute a save. protected _render (mixed $extension, mixed $quality) Execute a render. public __destruct () Destroys the loaded image to free up resources. public getInternalImInstance () Get instance public setResourceLimit (mixed $type, mixed $limit) Sets the limit for a particular resource in megabytes public getImage () inherited from Phalcon\Image\Adapter ... public getRealpath () inherited from Phalcon\Image\Adapter ... public getWidth () inherited from Phalcon\Image\Adapter Image width public getHeight () inherited from Phalcon\Image\Adapter Image height public getType () inherited from Phalcon\Image\Adapter Image type Driver dependent public getMime () inherited from Phalcon\Image\Adapter Image mime type public resize ([mixed $width], [mixed $height], [mixed $master]) inherited from Phalcon\Image\Adapter Resize the image to the given size public liquidRescale (mixed $width, mixed $height, [mixed $deltaX], [mixed $rigidity]) inherited from Phal- con\Image\Adapter This method scales the images using liquid rescaling method. Only support Imagick public crop (mixed $width, mixed $height, [mixed $offsetX], [mixed $offsetY]) inherited from Phalcon\Image\Adapter Crop an image to the given size public rotate (mixed $degrees) inherited from Phalcon\Image\Adapter Rotate the image by a given amount public flip (mixed $direction) inherited from Phalcon\Image\Adapter Flip the image along the horizontal or vertical axis
2.5. API 761 Phalcon PHP Framework Documentation, Release 3.1.1
public sharpen (mixed $amount) inherited from Phalcon\Image\Adapter Sharpen the image by a given amount public reflection (mixed $height, [mixed $opacity], [mixed $fadeIn]) inherited from Phalcon\Image\Adapter Add a reflection to an image public watermark (Phalcon\Image\Adapter $watermark, [mixed $offsetX], [mixed $offsetY], [mixed $opacity]) in- herited from Phalcon\Image\Adapter Add a watermark to an image with the specified opacity public text (mixed $text, [mixed $offsetX], [mixed $offsetY], [mixed $opacity], [mixed $color], [mixed $size], [mixed $fontfile]) inherited from Phalcon\Image\Adapter Add a text to an image with a specified opacity public mask (Phalcon\Image\Adapter $watermark) inherited from Phalcon\Image\Adapter Composite one image onto another public background (mixed $color, [mixed $opacity]) inherited from Phalcon\Image\Adapter Set the background color of an image public blur (mixed $radius) inherited from Phalcon\Image\Adapter Blur image public pixelate (mixed $amount) inherited from Phalcon\Image\Adapter Pixelate image public save ([mixed $file], [mixed $quality]) inherited from Phalcon\Image\Adapter Save the image public render ([mixed $ext], [mixed $quality]) inherited from Phalcon\Image\Adapter Render the image and return the binary string
Class Phalcon\Image\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message
final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Kernel
Methods
public static preComputeHashKey (mixed $key) ...
Class Phalcon\Loader implements Phalcon\Events\EventsAwareInterface This component helps to load your project classes automatically based on some conventions
2.5. API 763 Phalcon PHP Framework Documentation, Release 3.1.1
// Requiring this class will automatically include file vendor/example/adapter/Some.
˓→php $adapter= new \Example\Adapter\Some();
Methods public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the events manager public getEventsManager () Returns the internal event manager public setExtensions (array $extensions) Sets an array of file extensions that the loader must try in each attempt to locate the file public getExtensions () Returns the file extensions registered in the loader public registerNamespaces (array $namespaces, [mixed $merge]) Register namespaces and their related directories protected prepareNamespace (array $namespace) ... public getNamespaces () Returns the namespaces currently registered in the autoloader public registerDirs (array $directories, [mixed $merge]) Register directories in which “not found” classes could be found public getDirs () Returns the directories currently registered in the autoloader public registerFiles (array $files, [mixed $merge]) Registers files that are “non-classes” hence need a “require”. This is very useful for including files that only have functions public getFiles () Returns the files currently registered in the autoloader public registerClasses (array $classes, [mixed $merge]) Register classes and their locations public getClasses () Returns the class-map currently registered in the autoloader public register ([mixed $prepend]) Register the autoload method public unregister () Unregister the autoload method
764 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public loadFiles () Checks if a file exists and then adds the file by doing virtual require public autoLoad (mixed $className) Autoloads the registered classes public getFoundPath () Get the path when a class was found public getCheckedPath () Get the path the loader is checking for a path
Class Phalcon\Loader\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 765 Phalcon PHP Framework Documentation, Release 3.1.1
implements Phalcon\Logger\AdapterInterface Base class for Phalcon\Logger adapters
Methods
public setLogLevel (mixed $level) Filters the logs sent to the handlers that are less or equal than a specific level public getLogLevel () Returns the current log level public setFormatter (Phalcon\Logger\FormatterInterface $formatter) Sets the message formatter public begin () Starts a transaction public commit () Commits the internal transaction public rollback () Rollbacks the internal transaction public isTransaction () Returns the whether the logger is currently in an active transaction or not public critical (mixed $message, [array $context]) Sends/Writes a critical message to the log
766 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public emergency (mixed $message, [array $context]) Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) Sends/Writes a debug message to the log public error (mixed $message, [array $context]) Sends/Writes an error message to the log public info (mixed $message, [array $context]) Sends/Writes an info message to the log public notice (mixed $message, [array $context]) Sends/Writes a notice message to the log public warning (mixed $message, [array $context]) Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) Sends/Writes an alert message to the log public log (mixed $type, [mixed $message], [array $context]) Logs messages to the internal logger. Appends logs to the logger abstract public getFormatter () inherited from Phalcon\Logger\AdapterInterface ... abstract public close () inherited from Phalcon\Logger\AdapterInterface ...
Class Phalcon\Logger\Adapter\File extends abstract class Phalcon\Logger\Adapter implements Phalcon\Logger\AdapterInterface Adapter to store logs in plain text files
$logger= new \Phalcon\Logger\Adapter\File("app/logs/test.log");
$logger->log("This is a message"); $logger->log(\Phalcon\Logger::ERROR,"This is an error"); $logger->error("This is another error");
$logger->close();
Methods public getPath () File Path
2.5. API 767 Phalcon PHP Framework Documentation, Release 3.1.1 public __construct (string $name, [array $options]) Phalcon\Logger\Adapter\File constructor public getFormatter () Returns the internal formatter public logInternal (mixed $message, mixed $type, mixed $time, array $context) Writes the log to the file itself public close () Closes the logger public __wakeup () Opens the internal file handler after unserialization public setLogLevel (mixed $level) inherited from Phalcon\Logger\Adapter Filters the logs sent to the handlers that are less or equal than a specific level public getLogLevel () inherited from Phalcon\Logger\Adapter Returns the current log level public setFormatter (Phalcon\Logger\FormatterInterface $formatter) inherited from Phalcon\Logger\Adapter Sets the message formatter public begin () inherited from Phalcon\Logger\Adapter Starts a transaction public commit () inherited from Phalcon\Logger\Adapter Commits the internal transaction public rollback () inherited from Phalcon\Logger\Adapter Rollbacks the internal transaction public isTransaction () inherited from Phalcon\Logger\Adapter Returns the whether the logger is currently in an active transaction or not public critical (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a critical message to the log public emergency (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a debug message to the log public error (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an error message to the log public info (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an info message to the log public notice (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a notice message to the log
768 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public warning (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an alert message to the log public log (mixed $type, [mixed $message], [array $context]) inherited from Phalcon\Logger\Adapter Logs messages to the internal logger. Appends logs to the logger
Class Phalcon\Logger\Adapter\Firephp extends abstract class Phalcon\Logger\Adapter implements Phalcon\Logger\AdapterInterface Sends logs to FirePHP
$logger= new Firephp();
$logger->log(Logger::ERROR,"This is an error"); $logger->error("This is another error");
Methods public getFormatter () Returns the internal formatter public logInternal (mixed $message, mixed $type, mixed $time, array $context) Writes the log to the stream itself public close () Closes the logger public setLogLevel (mixed $level) inherited from Phalcon\Logger\Adapter Filters the logs sent to the handlers that are less or equal than a specific level public getLogLevel () inherited from Phalcon\Logger\Adapter Returns the current log level public setFormatter (Phalcon\Logger\FormatterInterface $formatter) inherited from Phalcon\Logger\Adapter Sets the message formatter public begin () inherited from Phalcon\Logger\Adapter Starts a transaction public commit () inherited from Phalcon\Logger\Adapter Commits the internal transaction
2.5. API 769 Phalcon PHP Framework Documentation, Release 3.1.1 public rollback () inherited from Phalcon\Logger\Adapter Rollbacks the internal transaction public isTransaction () inherited from Phalcon\Logger\Adapter Returns the whether the logger is currently in an active transaction or not public critical (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a critical message to the log public emergency (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a debug message to the log public error (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an error message to the log public info (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an info message to the log public notice (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a notice message to the log public warning (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an alert message to the log public log (mixed $type, [mixed $message], [array $context]) inherited from Phalcon\Logger\Adapter Logs messages to the internal logger. Appends logs to the logger
Class Phalcon\Logger\Adapter\Stream extends abstract class Phalcon\Logger\Adapter implements Phalcon\Logger\AdapterInterface Sends logs to a valid PHP stream
$logger= new Stream("php://stderr");
$logger->log("This is a message"); $logger->log(Logger::ERROR,"This is an error"); $logger->error("This is another error");
Methods public __construct (string $name, [array $options]) Phalcon\Logger\Adapter\Stream constructor public getFormatter () Returns the internal formatter public logInternal (mixed $message, mixed $type, mixed $time, array $context) Writes the log to the stream itself public close () Closes the logger public setLogLevel (mixed $level) inherited from Phalcon\Logger\Adapter Filters the logs sent to the handlers that are less or equal than a specific level public getLogLevel () inherited from Phalcon\Logger\Adapter Returns the current log level public setFormatter (Phalcon\Logger\FormatterInterface $formatter) inherited from Phalcon\Logger\Adapter Sets the message formatter public begin () inherited from Phalcon\Logger\Adapter Starts a transaction public commit () inherited from Phalcon\Logger\Adapter Commits the internal transaction public rollback () inherited from Phalcon\Logger\Adapter Rollbacks the internal transaction public isTransaction () inherited from Phalcon\Logger\Adapter Returns the whether the logger is currently in an active transaction or not public critical (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a critical message to the log public emergency (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a debug message to the log public error (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an error message to the log public info (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an info message to the log public notice (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a notice message to the log public warning (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter
2.5. API 771 Phalcon PHP Framework Documentation, Release 3.1.1
Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an alert message to the log public log (mixed $type, [mixed $message], [array $context]) inherited from Phalcon\Logger\Adapter Logs messages to the internal logger. Appends logs to the logger
Class Phalcon\Logger\Adapter\Syslog extends abstract class Phalcon\Logger\Adapter implements Phalcon\Logger\AdapterInterface Sends logs to the system logger
// LOG_USER is the only valid log type under Windows operating systems $logger= new Syslog( "ident", [ "option" => LOG_CONS| LOG_NDELAY| LOG_PID, "facility" => LOG_USER, ] );
$logger->log("This is a message"); $logger->log(Logger::ERROR,"This is an error"); $logger->error("This is another error");
Methods public __construct (string $name, [array $options]) Phalcon\Logger\Adapter\Syslog constructor public getFormatter () Returns the internal formatter public logInternal (mixed $message, mixed $type, mixed $time, array $context) Writes the log to the stream itself public close () Closes the logger public setLogLevel (mixed $level) inherited from Phalcon\Logger\Adapter Filters the logs sent to the handlers that are less or equal than a specific level public getLogLevel () inherited from Phalcon\Logger\Adapter Returns the current log level
772 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public setFormatter (Phalcon\Logger\FormatterInterface $formatter) inherited from Phalcon\Logger\Adapter Sets the message formatter public begin () inherited from Phalcon\Logger\Adapter Starts a transaction public commit () inherited from Phalcon\Logger\Adapter Commits the internal transaction public rollback () inherited from Phalcon\Logger\Adapter Rollbacks the internal transaction public isTransaction () inherited from Phalcon\Logger\Adapter Returns the whether the logger is currently in an active transaction or not public critical (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a critical message to the log public emergency (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a debug message to the log public error (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an error message to the log public info (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an info message to the log public notice (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a notice message to the log public warning (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) inherited from Phalcon\Logger\Adapter Sends/Writes an alert message to the log public log (mixed $type, [mixed $message], [array $context]) inherited from Phalcon\Logger\Adapter Logs messages to the internal logger. Appends logs to the logger
Class Phalcon\Logger\Exception extends class Phalcon\Exception implements Throwable
2.5. API 773 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Logger\Formatter implements Phalcon\Logger\FormatterInterface This is a base class for logger formatters
Methods public getTypeString (mixed $type) Returns the string meaning of a logger constant public interpolate (string $message, [array $context]) Interpolates context values into the message placeholders abstract public format (mixed $message, mixed $type, mixed $timestamp, [mixed $context]) inherited from Phal- con\Logger\FormatterInterface
Class Phalcon\Logger\Formatter\Firephp extends abstract class Phalcon\Logger\Formatter implements Phalcon\Logger\FormatterInterface Formats messages so that they can be sent to FirePHP
Methods public getTypeString (mixed $type) Returns the string meaning of a logger constant public setShowBacktrace ([mixed $isShow]) Returns the string meaning of a logger constant public getShowBacktrace () Returns the string meaning of a logger constant public enableLabels ([mixed $isEnable]) Returns the string meaning of a logger constant public labelsEnabled () Returns the labels enabled public string format (string $message, int $type, int $timestamp, [array $context]) Applies a format to a message before sending it to the log public interpolate (string $message, [array $context]) inherited from Phalcon\Logger\Formatter Interpolates context values into the message placeholders
Class Phalcon\Logger\Formatter\Json extends abstract class Phalcon\Logger\Formatter implements Phalcon\Logger\FormatterInterface Formats messages using JSON encoding
Methods public string format (string $message, int $type, int $timestamp, [array $context]) Applies a format to a message before sent it to the internal log public getTypeString (mixed $type) inherited from Phalcon\Logger\Formatter Returns the string meaning of a logger constant public interpolate (string $message, [array $context]) inherited from Phalcon\Logger\Formatter Interpolates context values into the message placeholders
2.5. API 775 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Logger\Formatter\Line extends abstract class Phalcon\Logger\Formatter implements Phalcon\Logger\FormatterInterface Formats messages using an one-line string
Methods public getDateFormat () Default date format public setDateFormat (mixed $dateFormat) Default date format public getFormat () Format applied to each message public setFormat (mixed $format) Format applied to each message public __construct ([string $format], [string $dateFormat]) Phalcon\Logger\Formatter\Line construct public string format (string $message, int $type, int $timestamp, [array $context]) Applies a format to a message before sent it to the internal log public getTypeString (mixed $type) inherited from Phalcon\Logger\Formatter Returns the string meaning of a logger constant public interpolate (string $message, [array $context]) inherited from Phalcon\Logger\Formatter Interpolates context values into the message placeholders
Class Phalcon\Logger\Formatter\Syslog extends abstract class Phalcon\Logger\Formatter implements Phalcon\Logger\FormatterInterface Prepares a message to be used in a Syslog backend
Methods public array format (string $message, int $type, int $timestamp, [array $context]) Applies a format to a message before sent it to the internal log public getTypeString (mixed $type) inherited from Phalcon\Logger\Formatter Returns the string meaning of a logger constant public interpolate (string $message, [array $context]) inherited from Phalcon\Logger\Formatter Interpolates context values into the message placeholders
public getType () Log type public getMessage () Log message public getTime () Log timestamp public getContext () ... public __construct (string $message, integer $type, [integer $time], [array $context]) Phalcon\Logger\Item constructor
Class Phalcon\Logger\Multiple
Handles multiples logger handlers
Methods
public getLoggers () ... public getFormatter () ... public getLogLevel () ... public push (Phalcon\Logger\AdapterInterface $logger) Pushes a logger to the logger tail public setFormatter (Phalcon\Logger\FormatterInterface $formatter) Sets a global formatter public setLogLevel (mixed $level) Sets a global level public log (mixed $type, [mixed $message], [array $context]) Sends a message to each registered logger public critical (mixed $message, [array $context]) Sends/Writes an critical message to the log
2.5. API 777 Phalcon PHP Framework Documentation, Release 3.1.1 public emergency (mixed $message, [array $context]) Sends/Writes an emergency message to the log public debug (mixed $message, [array $context]) Sends/Writes a debug message to the log public error (mixed $message, [array $context]) Sends/Writes an error message to the log public info (mixed $message, [array $context]) Sends/Writes an info message to the log public notice (mixed $message, [array $context]) Sends/Writes a notice message to the log public warning (mixed $message, [array $context]) Sends/Writes a warning message to the log public alert (mixed $message, [array $context]) Sends/Writes an alert message to the log
Class Phalcon\Mvc\Application extends abstract class Phalcon\Application implements Phalcon\Di\InjectionAwareInterface, Phalcon\Events\EventsAwareInterface This component encapsulates all the complex operations behind instantiating every component needed and integrating it with the rest to allow the MVC pattern to operate as desired.
}
/** * This method registers all the modules in the application */ public function main() { $this->registerModules( [ "frontend" =>[ "className" =>"Multiple \\Frontend\\Module", "path" =>"../apps/frontend/Module.php", ],
public useImplicitView (mixed $implicitView) By default. The view is implicitly buffering all the output You can full disable the view component using this method public handle ([mixed $uri]) Handles a MVC request public __construct ([Phalcon\DiInterface $dependencyInjector]) inherited from Phalcon\Application Phalcon\Application public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Application Sets the events manager public getEventsManager () inherited from Phalcon\Application Returns the internal event manager public registerModules (array $modules, [mixed $merge]) inherited from Phalcon\Application Register an array of modules present in the application
public getModules () inherited from Phalcon\Application Return the modules registered in the application public getModule (mixed $name) inherited from Phalcon\Application Gets the module definition registered in the application via module name
2.5. API 779 Phalcon PHP Framework Documentation, Release 3.1.1
public setDefaultModule (mixed $defaultModule) inherited from Phalcon\Application Sets the module name to be used if the router doesn’t return a valid module public getDefaultModule () inherited from Phalcon\Application Returns the default module name public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\Application\Exception
extends class Phalcon\Application\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string
780 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Mvc\Collection implements Phalcon\Mvc\EntityInterface, Phalcon\Mvc\CollectionInterface, Phalcon\Di\InjectionAwareInterface, Serializable This component implements a high level abstraction for NoSQL databases which works with documents
final public __construct ([Phalcon\DiInterface $dependencyInjector], [Phalcon\Mvc\Collection\ManagerInterface $modelsManager]) Phalcon\Mvc\Collection constructor public setId (mixed $id) Sets a value for the _id property, creates a MongoId object if needed public MongoId getId () Returns the value of the _id property public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injection container public getDI () Returns the dependency injection container protected setEventsManager (Phalcon\Mvc\Collection\ManagerInterface $eventsManager) Sets a custom events manager protected getEventsManager () Returns the custom events manager public getCollectionManager () Returns the models manager related to the entity instance public getReservedAttributes ()
2.5. API 781 Phalcon PHP Framework Documentation, Release 3.1.1
Returns an array with reserved properties that cannot be part of the insert/update protected useImplicitObjectIds (mixed $useImplicitObjectIds) Sets if a model must use implicit objects ids protected setSource (mixed $source) Sets collection name which model should be mapped public getSource () Returns collection name mapped in the model public setConnectionService (mixed $connectionService) Sets the DependencyInjection connection service name public getConnectionService () Returns DependencyInjection connection service public MongoDb getConnection () Retrieves a database connection public mixed readAttribute (string $attribute) Reads an attribute value by its name
echo $robot->readAttribute("name");
public writeAttribute (string $attribute, mixed $value) Writes an attribute value by its name
$robot->writeAttribute("name","Rosey");
public static cloneResult (Phalcon\Mvc\CollectionInterface $collection, array $document) Returns a cloned collection protected static array _getResultset (array $params, Phalcon\Mvc\Collection $collection, MongoDb $connection, boolean $unique) Returns a collection resultset protected static int _getGroupResultset (array $params, Phalcon\Mvc\Collection $collection, MongoDb $connec- tion) Perform a count over a resultset final protected boolean _preSave (Phalcon\DiInterface $dependencyInjector, boolean $disableEvents, boolean $ex- ists) Executes internal hooks before save a document final protected _postSave (mixed $disableEvents, mixed $success, mixed $exists) Executes internal events after save a document protected validate (mixed $validator) Executes validators on every validation call
if ($this->validationHasFailed() == true){ return false; } } } public fireEvent (mixed $eventName) Fires an internal event public fireEventCancel (mixed $eventName) Fires an internal event that cancels the operation protected _cancelOperation (mixed $disableEvents) Cancel the current operation protected boolean _exists (MongoCollection $collection) Checks if the document exists in the collection public getMessages () Returns all the validation messages
$robot= new Robots();
$robot->type="mechanical"; $robot->name="Astro Boy"; $robot->year= 1952; if ($robot->save() === false){ echo "Umh, We can't store robots right now";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message; } } else { echo "Great, a new robot was saved successfully!"; } public appendMessage (Phalcon\Mvc\Model\MessageInterface $message) Appends a customized message on the validation process
class Robots extends \Phalcon\Mvc\Model { public function beforeSave() { if ($this->name ==="Peter"){ $message= new Message( "Sorry, but a robot cannot be named Peter" );
$this->appendMessage(message); } } }
protected prepareCU () Shared Code for CU Operations Prepares Collection public save () Creates/Updates a collection based on the values in the attributes public create () Creates a collection based on the values in the attributes public createIfNotExist (array $criteria) Creates a document based on the values in the attributes, if not found by criteria Preferred way to avoid duplication is to create index on attribute
$robot= new Robot();
$robot->name="MyRobot"; $robot->type="Droid";
// Create only if robot with same name and type does not exist $robot->createIfNotExist( [ "name", "type", ] );
public update () Creates/Updates a collection based on the values in the attributes public static findById (mixed $id) Find a document by its id (_id)
// Find user by using \MongoId object $user= Users::findById( new \MongoId("545eb081631d16153a293a66")
2.5. API 785 Phalcon PHP Framework Documentation, Release 3.1.1
);
// Find user by using id as sting $user= Users::findById("45cbc4a0e4123f6920000002");
// Validate input if ($user= Users::findById($_POST["id"])) { // ... } public static findFirst ([array $parameters]) Allows to query the first record that match the specified conditions
// What's the first robot in the robots table? $robot= Robots::findFirst(); echo "The robot name is", $robot->name," \n";
// What's the first mechanical robot in robots table? $robot= Robots::findFirst( [ [ "type" =>"mechanical", ] ] ); echo "The first mechanical robot name is", $robot->name," \n";
// Get first virtual robot ordered by name $robot= Robots::findFirst( [ [ "type" =>"mechanical", ], "order" =>[ "name" =>1, ], ] ); echo "The first virtual robot name is", $robot->name," \n";
// Get first robot by id (_id) $robot= Robots::findFirst( [ [ "_id" => new \MongoId("45cbc4a0e4123f6920000002"), ] ] ); echo "The robot id is", $robot->_id," \n"; public static find ([array $parameters])
Allows to query a set of records that match the specified conditions
// How many robots are there? $robots= Robots::find(); echo "There are", count($robots)," \n";
// How many mechanical robots are there? $robots= Robots::find( [ [ "type" =>"mechanical", ] ] ); echo "There are", count(robots)," \n";
// Get and print virtual robots ordered by name $robots= Robots::findFirst( [ [ "type" =>"virtual" ], "order" =>[ "name" =>1, ] ] ); foreach ($robots as $robot){ echo $robot->name," \n"; }
// Get first 100 virtual robots ordered by name $robots= Robots::find( [ [ "type" =>"virtual", ], "order" =>[ "name" =>1, ], "limit" => 100, ] ); foreach ($robots as $robot){ echo $robot->name," \n"; } public static count ([array $parameters]) Perform a count over a collection
2.5. API 787 Phalcon PHP Framework Documentation, Release 3.1.1
echo "There are", Robots::count()," robots"; public static aggregate ([array $parameters]) Perform an aggregation using the Mongo aggregation framework public static summatory (mixed $field, [mixed $conditions], [mixed $finalize]) Allows to perform a summatory group for a column in the collection public delete () Deletes a model instance. Returning true on success or false otherwise.
$robot= Robots::findFirst();
$robot->delete();
$robots= Robots::find(); foreach ($robots as $robot){ $robot->delete(); } public setDirtyState (mixed $dirtyState) Sets the dirty state of the object using one of the DIRTY_STATE_* constants public getDirtyState () Returns one of the DIRTY_STATE_* constants telling if the document exists in the collection or not protected addBehavior (Phalcon\Mvc\Collection\BehaviorInterface $behavior) Sets up a behavior in a collection public skipOperation (mixed $skip) Skips the current operation forcing a success state public toArray () Returns the instance as an array representation
toArray() ); public serialize () Serializes the object ignoring connections or protected properties public unserialize (mixed $data) Unserializes the object from a serialized string
Abstract class Phalcon\Mvc\Collection\Behavior implements Phalcon\Mvc\Collection\BehaviorInterface
Methods public __construct ([array $options]) protected mustTakeAction (mixed $eventName) Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) Returns the behavior options related to an event public notify (mixed $type, Phalcon\Mvc\CollectionInterface $model) This method receives the notifications from the EventsManager public missingMethod (Phalcon\Mvc\CollectionInterface $model, mixed $method, [mixed $arguments]) Acts as fallbacks when a missing method is called on the collection
Class Phalcon\Mvc\Collection\Behavior\SoftDelete extends abstract class Phalcon\Mvc\Collection\Behavior implements Phalcon\Mvc\Collection\BehaviorInterface Instead of permanently delete a record it marks the record as deleted changing the value of a flag column
Methods public notify (mixed $type, Phalcon\Mvc\CollectionInterface $model) Listens for notifications from the models manager public __construct ([array $options]) inherited from Phalcon\Mvc\Collection\Behavior Phalcon\Mvc\Collection\Behavior protected mustTakeAction (mixed $eventName) inherited from Phalcon\Mvc\Collection\Behavior Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) inherited from Phalcon\Mvc\Collection\Behavior Returns the behavior options related to an event public missingMethod (Phalcon\Mvc\CollectionInterface $model, mixed $method, [mixed $arguments]) inherited from Phalcon\Mvc\Collection\Behavior Acts as fallbacks when a missing method is called on the collection
Class Phalcon\Mvc\Collection\Behavior\Timestampable extends abstract class Phalcon\Mvc\Collection\Behavior implements Phalcon\Mvc\Collection\BehaviorInterface Allows to automatically update a model’s attribute saving the datetime when a record is created or updated
2.5. API 789 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public notify (mixed $type, Phalcon\Mvc\CollectionInterface $model) Listens for notifications from the models manager public __construct ([array $options]) inherited from Phalcon\Mvc\Collection\Behavior Phalcon\Mvc\Collection\Behavior protected mustTakeAction (mixed $eventName) inherited from Phalcon\Mvc\Collection\Behavior Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) inherited from Phalcon\Mvc\Collection\Behavior Returns the behavior options related to an event public missingMethod (Phalcon\Mvc\CollectionInterface $model, mixed $method, [mixed $arguments]) inherited from Phalcon\Mvc\Collection\Behavior Acts as fallbacks when a missing method is called on the collection
Class Phalcon\Mvc\Collection\Document
implements Phalcon\Mvc\EntityInterface, ArrayAccess This component allows Phalcon\Mvc\Collection to return rows without an associated entity. This objects implements the ArrayAccess interface to allow access the object as object->x or array[x].
Methods
public boolean offsetExists (int $index) Checks whether an offset exists in the document public offsetGet (mixed $index) Returns the value of a field using the ArrayAccess interfase public offsetSet (mixed $index, mixed $value) Change a value using the ArrayAccess interface public offsetUnset (string $offset) Rows cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public mixed readAttribute (string $attribute) Reads an attribute value by its name
echo $robot->readAttribute("name");
public writeAttribute (string $attribute, mixed $value) Writes an attribute value by its name
public array toArray () Returns the instance as an array representation
Class Phalcon\Mvc\Collection\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 791 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Mvc\Collection\Manager
implements Phalcon\Di\InjectionAwareInterface, Phalcon\Events\EventsAwareInterface This components controls the initialization of models, keeping record of relations between the different models of the application. A CollectionManager is injected to a model via a Dependency Injector Container such as Phalcon\Di.
$di= new \Phalcon\Di();
$di->set( "collectionManager", function () { return new \Phalcon\Mvc\Collection\Manager(); } );
$robot= new Robots($di);
Methods
public getServiceName () ... public setServiceName (mixed $serviceName) ... public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the event manager public getEventsManager () Returns the internal event manager public setCustomEventsManager (Phalcon\Mvc\CollectionInterface $model, Phalcon\Events\ManagerInterface $eventsManager) Sets a custom events manager for a specific model public getCustomEventsManager (Phalcon\Mvc\CollectionInterface $model) Returns a custom events manager related to a model public initialize (Phalcon\Mvc\CollectionInterface $model) Initializes a model in the models manager public isInitialized (mixed $modelName) Check whether a model is already initialized
792 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public getLastInitialized () Get the latest initialized model public setConnectionService (Phalcon\Mvc\CollectionInterface $model, mixed $connectionService) Sets a connection service for a specific model public getConnectionService (Phalcon\Mvc\CollectionInterface $model) Gets a connection service for a specific model public useImplicitObjectIds (Phalcon\Mvc\CollectionInterface $model, mixed $useImplicitObjectIds) Sets whether a model must use implicit objects ids public isUsingImplicitObjectIds (Phalcon\Mvc\CollectionInterface $model) Checks if a model is using implicit object ids public Mongo getConnection (Phalcon\Mvc\CollectionInterface $model) Returns the connection related to a model public notifyEvent (mixed $eventName, Phalcon\Mvc\CollectionInterface $model) Receives events generated in the models and dispatches them to an events-manager if available Notify the behaviors that are listening in the model public missingMethod (Phalcon\Mvc\CollectionInterface $model, mixed $eventName, mixed $data) Dispatch an event to the listeners and behaviors This method expects that the endpoint listeners/behaviors returns true meaning that at least one was implemented public addBehavior (Phalcon\Mvc\CollectionInterface $model, Phalcon\Mvc\Collection\BehaviorInterface $behav- ior) Binds a behavior to a model
Abstract class Phalcon\Mvc\Controller extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Mvc\ControllerInterface Every application controller should extend this class that encapsulates all the controller functionality The controllers provide the “flow” between models and views. Controllers are responsible for processing the incoming requests from the web browser, interrogating the models for data, and passing that data on to the views for presentation.
}
public function findAction()
2.5. API 793 Phalcon PHP Framework Documentation, Release 3.1.1
{
}
public function saveAction() { // Forwards flow to the index action return $this->dispatcher->forward( [ "controller" =>"people", "action" =>"index", ] ); } }
Methods
final public __construct () Phalcon\Mvc\Controller constructor public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\Dispatcher
extends abstract class Phalcon\Dispatcher implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\DispatcherInterface, Phalcon\Mvc\DispatcherInterface Dispatching is the process of taking the request object, extracting the module name, controller name, action name, and optional parameters contained in it, and then instantiating a controller and calling an action of that controller.
Methods public setControllerSuffix (mixed $controllerSuffix) Sets the default controller suffix public setDefaultController (mixed $controllerName) Sets the default controller name public setControllerName (mixed $controllerName) Sets the controller name to be dispatched public getControllerName () Gets last dispatched controller name public getPreviousNamespaceName () Gets previous dispatched namespace name public getPreviousControllerName () Gets previous dispatched controller name public getPreviousActionName () Gets previous dispatched action name protected _throwDispatchException (mixed $message, [mixed $exceptionCode]) Throws an internal exception protected _handleException (Exception $exception) Handles a user exception public getControllerClass () Possible controller class name that will be located to dispatch the request
2.5. API 795 Phalcon PHP Framework Documentation, Release 3.1.1
public getLastController () Returns the latest dispatched controller public getActiveController () Returns the active controller in the dispatcher public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Dispatcher Sets the dependency injector public getDI () inherited from Phalcon\Dispatcher Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Dispatcher Sets the events manager public getEventsManager () inherited from Phalcon\Dispatcher Returns the internal event manager public setActionSuffix (mixed $actionSuffix) inherited from Phalcon\Dispatcher Sets the default action suffix public getActionSuffix () inherited from Phalcon\Dispatcher Gets the default action suffix public setModuleName (mixed $moduleName) inherited from Phalcon\Dispatcher Sets the module where the controller is (only informative) public getModuleName () inherited from Phalcon\Dispatcher Gets the module where the controller class is public setNamespaceName (mixed $namespaceName) inherited from Phalcon\Dispatcher Sets the namespace where the controller class is public getNamespaceName () inherited from Phalcon\Dispatcher Gets a namespace to be prepended to the current handler name public setDefaultNamespace (mixed $namespaceName) inherited from Phalcon\Dispatcher Sets the default namespace public getDefaultNamespace () inherited from Phalcon\Dispatcher Returns the default namespace public setDefaultAction (mixed $actionName) inherited from Phalcon\Dispatcher Sets the default action name public setActionName (mixed $actionName) inherited from Phalcon\Dispatcher Sets the action name to be dispatched public getActionName () inherited from Phalcon\Dispatcher Gets the latest dispatched action name public setParams (array $params) inherited from Phalcon\Dispatcher Sets action params to be dispatched
796 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public getParams () inherited from Phalcon\Dispatcher Gets action params public setParam (mixed $param, mixed $value) inherited from Phalcon\Dispatcher Set a param by its name or numeric index public mixed getParam (mixed $param, [string | array $filters], [mixed $defaultValue]) inherited from Phal- con\Dispatcher Gets a param by its name or numeric index public boolean hasParam (mixed $param) inherited from Phalcon\Dispatcher Check if a param exists public getActiveMethod () inherited from Phalcon\Dispatcher Returns the current method to be/executed in the dispatcher public isFinished () inherited from Phalcon\Dispatcher Checks if the dispatch loop is finished or has more pendent controllers/tasks to dispatch public setReturnedValue (mixed $value) inherited from Phalcon\Dispatcher Sets the latest returned value by an action manually public mixed getReturnedValue () inherited from Phalcon\Dispatcher Returns value returned by the latest dispatched action public setModelBinding (mixed $value, [mixed $cache]) inherited from Phalcon\Dispatcher Enable/Disable model binding during dispatch
$di->set('dispatcher', function() { $dispatcher= new Dispatcher();
$dispatcher->setModelBinding(true, 'cache'); return $dispatcher; }); public setModelBinder (Phalcon\Mvc\Model\BinderInterface $modelBinder, [mixed $cache]) inherited from Phal- con\Dispatcher Enable model binding during dispatch
$di->set('dispatcher', function() { $dispatcher= new Dispatcher();
$dispatcher->setModelBinder(new Binder(), 'cache'); return $dispatcher; }); public getModelBinder () inherited from Phalcon\Dispatcher Gets model binder public object dispatch () inherited from Phalcon\Dispatcher
2.5. API 797 Phalcon PHP Framework Documentation, Release 3.1.1
Dispatches a handle action taking into account the routing parameters protected object _dispatch () inherited from Phalcon\Dispatcher Dispatches a handle action taking into account the routing parameters public forward (array $forward) inherited from Phalcon\Dispatcher Forwards the execution flow to another controller/action Dispatchers are unique per module. Forwarding between modules is not allowed
$this->dispatcher->forward( [ "controller" =>"posts", "action" =>"index", ] ); public wasForwarded () inherited from Phalcon\Dispatcher Check if the current executed action was forwarded by another one public getHandlerClass () inherited from Phalcon\Dispatcher Possible class name that will be located to dispatch the request public callActionMethod (mixed $handler, mixed $actionMethod, [array $params]) inherited from Phal- con\Dispatcher ... public getBoundModels () inherited from Phalcon\Dispatcher Returns bound models from binder instance
dispatcher->getBoundModels(); // return array with $user } } protected _resolveEmptyProperties () inherited from Phalcon\Dispatcher Set empty properties to their defaults (where defaults are available)
Class Phalcon\Mvc\Dispatcher\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception
Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\Micro extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, ArrayAccess With Phalcon you can create “Micro-Framework like” applications. By doing this, you only need to write a minimal amount of code to create a PHP application. Micro applications are suitable to small applications, APIs and prototypes in a practical way.
$app= new \Phalcon\Mvc\Micro();
$app->get( "/say/welcome/{name}", function ($name){ echo "
Welcome $name!
"; } );
$app->handle();
2.5. API 799 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public __construct ([Phalcon\DiInterface $dependencyInjector]) Phalcon\Mvc\Micro constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public Phalcon\Mvc\Router\RouteInterface map (string $routePattern, callable $handler) Maps a route to a handler without any HTTP method constraint public Phalcon\Mvc\Router\RouteInterface get (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is GET public Phalcon\Mvc\Router\RouteInterface post (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is POST public Phalcon\Mvc\Router\RouteInterface put (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is PUT public Phalcon\Mvc\Router\RouteInterface patch (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is PATCH public Phalcon\Mvc\Router\RouteInterface head (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is HEAD public Phalcon\Mvc\Router\RouteInterface delete (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is DELETE public Phalcon\Mvc\Router\RouteInterface options (string $routePattern, callable $handler) Maps a route to a handler that only matches if the HTTP method is OPTIONS public mount (Phalcon\Mvc\Micro\CollectionInterface $collection) Mounts a collection of handlers public Phalcon\Mvc\Micro notFound (callable $handler) Sets a handler that will be called when the router doesn’t match any of the defined routes public Phalcon\Mvc\Micro error (callable $handler) Sets a handler that will be called when an exception is thrown handling the route public getRouter () Returns the internal router used by the application public Phalcon\Di\ServiceInterface setService (string $serviceName, mixed $definition, [boolean $shared]) Sets a service from the DI public hasService (mixed $serviceName) Checks if a service is registered in the DI public object getService (string $serviceName) Obtains a service from the DI public mixed getSharedService (string $serviceName)
Obtains a shared service from the DI public mixed handle ([string $uri]) Handle the whole request public stop () Stops the middleware execution avoiding than other middlewares be executed public setActiveHandler (callable $activeHandler) Sets externally the handler that must be called by the matched route public callable getActiveHandler () Return the handler that will be called for the matched route public mixed getReturnedValue () Returns the value returned by the executed handler public boolean offsetExists (string $alias) Check if a service is registered in the internal services container using the array syntax public offsetSet (string $alias, mixed $definition) Allows to register a shared service in the internal services container using the array syntax
$app["request"]= new \Phalcon\Http\Request();
public mixed offsetGet (string $alias) Allows to obtain a shared service in the internal services container using the array syntax
var_dump( $app["request"] );
public offsetUnset (string $alias) Removes a service from the internal services container using the array syntax public Phalcon\Mvc\Micro before (callable $handler) Appends a before middleware to be called before execute the route public Phalcon\Mvc\Micro afterBinding (callable $handler) Appends a afterBinding middleware to be called after model binding public Phalcon\Mvc\Micro after (callable $handler) Appends an ‘after’ middleware to be called after execute the route public Phalcon\Mvc\Micro finish (callable $handler) Appends a ‘finish’ middleware to be called when the request is finished public getHandlers () Returns the internal handlers attached to the application
2.5. API 801 Phalcon PHP Framework Documentation, Release 3.1.1 public getModelBinder () Gets model binder public setModelBinder (Phalcon\Mvc\Model\BinderInterface $modelBinder, [mixed $cache]) Sets model binder
$micro= new Micro($di); $micro->setModelBinder(new Binder(), 'cache'); public getBoundModels () Returns bound models from binder instance public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\Micro\Collection implements Phalcon\Mvc\Micro\CollectionInterface Groups Micro-Mvc handlers as controllers
$app= new \Phalcon\Mvc\Micro();
$collection= new Collection();
$collection->setHandler( new PostsController() );
$collection->get("/posts/edit/{id}","edit");
$app->mount($collection);
Methods protected _addMap (string | array $method, string $routePattern, mixed $handler, string $name) Internal function to add a handler to the group public setPrefix (mixed $prefix)
Sets a prefix for all routes added to the collection public getPrefix () Returns the collection prefix if any public array getHandlers () Returns the registered handlers public Phalcon\Mvc\Micro\Collection setHandler (mixed $handler, [boolean $lazy]) Sets the main handler public setLazy (mixed $lazy) Sets if the main handler must be lazy loaded public isLazy () Returns if the main handler must be lazy loaded public mixed getHandler () Returns the main handler public Phalcon\Mvc\Micro\Collection map (string $routePattern, callable $handler, [string $name]) Maps a route to a handler public Phalcon\Mvc\Micro\Collection get (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is GET public Phalcon\Mvc\Micro\Collection post (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is POST public Phalcon\Mvc\Micro\Collection put (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is PUT public Phalcon\Mvc\Micro\Collection patch (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is PATCH public Phalcon\Mvc\Micro\Collection head (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is HEAD public Phalcon\Mvc\Micro\Collection delete (string $routePattern, callable $handler, [string $name]) Maps a route to a handler that only matches if the HTTP method is DELETE public Phalcon\Mvc\Micro\Collection options (string $routePattern, callable $handler, [mixed $name]) Maps a route to a handler that only matches if the HTTP method is OPTIONS
Class Phalcon\Mvc\Micro\Exception extends class Phalcon\Exception implements Throwable
2.5. API 803 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\Micro\LazyLoader
Lazy-Load of handlers for Mvc\Micro using auto-loading
Methods public getDefinition () ... public __construct (mixed $definition) Phalcon\Mvc\Micro\LazyLoader constructor public mixed __call (string $method, array $arguments) Initializes the internal handler, calling functions on it public mixed callMethod (string $method, array $arguments, [Phalcon\Mvc\Model\BinderInterface $modelBinder])
implements Phalcon\Mvc\EntityInterface, Phalcon\Mvc\ModelInterface, Phalcon\Mvc\Model\ResultInterface, Phal- con\Di\InjectionAwareInterface, Serializable, JsonSerializable Phalcon\Mvc\Model connects business objects and database tables to create a persistable domain model where logic and data are presented in one wrapping. It‘s an implementation of the object-relational mapping (ORM). A model represents the information (data) of the application and the rules to manipulate that data. Models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, each table in your database will correspond to one model in your application. The bulk of your application’s business logic will be concentrated in the models. Phalcon\Mvc\Model is the first ORM written in Zephir/C languages for PHP, giving to developers high performance when interacting with databases while is also easy to use.
2.5. API 805 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final public __construct ([mixed $data], [Phalcon\DiInterface $dependencyInjector], [Phal- con\Mvc\Model\ManagerInterface $modelsManager]) Phalcon\Mvc\Model constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injection container public getDI () Returns the dependency injection container protected setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets a custom events manager protected getEventsManager () Returns the custom events manager public getModelsMetaData () Returns the models meta-data service related to the entity instance public getModelsManager () Returns the models manager related to the entity instance public setTransaction (Phalcon\Mvc\Model\TransactionInterface $transaction) Sets a transaction related to the Model instance
use Phalcon\Mvc\Model\Transaction\Manager as TxManager; use Phalcon\Mvc\Model\Transaction\Failed as TxFailed;
$transaction->rollback("Robot part cannot be saved"); }
$transaction->commit(); } catch (TxFailed $e){ echo "Failed, reason:", $e->getMessage(); } protected setSource (mixed $source) Sets the table name to which model should be mapped public getSource () Returns the table name mapped in the model protected setSchema (mixed $schema) Sets schema name where the mapped table is located public getSchema () Returns schema name where the mapped table is located public setConnectionService (mixed $connectionService) Sets the DependencyInjection connection service name public setReadConnectionService (mixed $connectionService) Sets the DependencyInjection connection service name used to read data public setWriteConnectionService (mixed $connectionService) Sets the DependencyInjection connection service name used to write data public getReadConnectionService () Returns the DependencyInjection connection service name used to read data related the model public getWriteConnectionService () Returns the DependencyInjection connection service name used to write data related to the model public setDirtyState (mixed $dirtyState) Sets the dirty state of the object using one of the DIRTY_STATE_* constants public getDirtyState () Returns one of the DIRTY_STATE_* constants telling if the record exists in the database or not public getReadConnection () Gets the connection used to read data for the model public getWriteConnection () Gets the connection used to write data to the model public Phalcon\Mvc\Model assign (array $data, [mixed $dataColumnMap], [array $whiteList]) Assigns values to a model from an array
$robot->assign( [
2.5. API 807 Phalcon PHP Framework Documentation, Release 3.1.1
// Assign by db row, column map needed $robot->assign( $dbRow, [ "db_type" =>"type", "db_name" =>"name", "db_year" =>"year", ] );
// Allow assign only name and year $robot->assign( $_POST, null, [ "name", "year", ] ); public static cloneResultMap (Phalcon\Mvc\ModelInterface | Phalcon\Mvc\Model\Row $base, array $data, array $columnMap, [int $dirtyState], [boolean $keepSnapshots]) Assigns values to a model from an array, returning a new model.
$robot= \Phalcon\Mvc\Model::cloneResultMap( new Robots(), [ "type" =>"mechanical", "name" =>"Astro Boy", "year" => 1952, ] ); public static mixed cloneResultMapHydrate (array $data, array $columnMap, int $hydrationMode) Returns an hydrated result based on the data and the column map public static Phalcon\Mvc\ModelInterface cloneResult (Phalcon\Mvc\ModelInterface $base, array $data, [int $dirtyState]) Assigns values to a model from an array returning a new model
] ); public static find ([mixed $parameters]) Query for a set of records that match the specified conditions
// How many robots are there? $robots= Robots::find(); echo "There are", count($robots)," \n";
// How many mechanical robots are there? $robots= Robots::find( "type = 'mechanical'" ); echo "There are", count($robots)," \n";
// Get and print virtual robots ordered by name $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", ] ); foreach ($robots as $robot){ echo $robot->name," \n"; }
// Get first 100 virtual robots ordered by name $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", "limit" => 100, ] ); foreach ($robots as $robot){ echo $robot->name," \n"; } public static static findFirst ([string | array $parameters]) Query the first record that matches the specified conditions
// What's the first robot in robots table? $robot= Robots::findFirst(); echo "The robot name is", $robot->name;
// What's the first mechanical robot in robots table? $robot= Robots::findFirst(
2.5. API 809 Phalcon PHP Framework Documentation, Release 3.1.1
"type = 'mechanical'" );
echo "The first mechanical robot name is", $robot->name;
// Get first virtual robot ordered by name $robot= Robots::findFirst( [ "type = 'virtual'", "order" =>"name", ] );
echo "The first virtual robot name is", $robot->name;
public static query ([Phalcon\DiInterface $dependencyInjector]) Create a criteria for a specific model protected boolean _exists (Phalcon\Mvc\Model\MetaDataInterface $metaData, Phalcon\Db\AdapterInterface $con- nection, [string | array $table]) Checks whether the current record already exists protected static Phalcon\Mvc\Model\ResultsetInterface _groupResult (mixed $functionName, string $alias, array $parameters) Generate a PHQL SELECT statement for an aggregate public static mixed count ([array $parameters]) Counts how many records match the specified conditions
// How many robots are there? $number= Robots::count();
echo "There are", $number," \n";
// How many mechanical robots are there? $number= Robots::count("type = 'mechanical'");
$sum= Robots::sum( [ "type = 'mechanical'", "column" =>"price", ] ); echo "The total price of mechanical robots is", $sum," \n"; public static mixed maximum ([array $parameters]) Returns the maximum value of a column for a result-set of rows that match the specified conditions
// What is the maximum robot id? $id= Robots::maximum( [ "column" =>"id", ] ); echo "The maximum robot id is:", $id," \n";
// What is the maximum id of mechanical robots? $sum= Robots::maximum( [ "type = 'mechanical'", "column" =>"id", ] ); echo "The maximum robot id of mechanical robots is", $id," \n"; public static mixed minimum ([array $parameters]) Returns the minimum value of a column for a result-set of rows that match the specified conditions
// What is the minimum robot id? $id= Robots::minimum( [ "column" =>"id", ] ); echo "The minimum robot id is:", $id;
// What is the minimum id of mechanical robots? $sum= Robots::minimum( [ "type = 'mechanical'", "column" =>"id", ] ); echo "The minimum robot id of mechanical robots is", $id;
2.5. API 811 Phalcon PHP Framework Documentation, Release 3.1.1 public static double average ([array $parameters]) Returns the average value on a column for a result-set of rows matching the specified conditions
// What's the average price of robots? $average= Robots::average( [ "column" =>"price", ] ); echo "The average price is", $average," \n";
// What's the average price of mechanical robots? $average= Robots::average( [ "type = 'mechanical'", "column" =>"price", ] ); echo "The average price of mechanical robots is", $average," \n"; public fireEvent (mixed $eventName) Fires an event, implicitly calls behaviors and listeners in the events manager are notified public fireEventCancel (mixed $eventName) Fires an event, implicitly calls behaviors and listeners in the events manager are notified This method stops if one of the callbacks/listeners returns boolean false protected _cancelOperation () Cancel the current operation public appendMessage (Phalcon\Mvc\Model\MessageInterface $message) Appends a customized message on the validation process
name ==="Peter"){ $message= new Message( "Sorry, but a robot cannot be named Peter" );
$this->appendMessage($message); } } }
812 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 protected validate (Phalcon\ValidationInterface $validator) Executes validators on every validation call
if ($robot->save() === false){ echo "Umh, We can't store robots right now";
$messages= $robot->getMessages();
foreach ($messages as $message){ echo $message; } } else { echo "Great, a new robot was saved successfully!"; }
final protected _checkForeignKeysRestrict () Reads “belongs to” relations and check the virtual foreign keys when inserting or updating records to verify that inserted/updated values are present in the related entity final protected _checkForeignKeysReverseCascade () Reads both “hasMany” and “hasOne” relations and checks the virtual foreign keys (cascade) when deleting records final protected _checkForeignKeysReverseRestrict () Reads both “hasMany” and “hasOne” relations and checks the virtual foreign keys (restrict) when deleting records protected _preSave (Phalcon\Mvc\Model\MetaDataInterface $metaData, mixed $exists, mixed $identityField) Executes internal hooks before save a record protected _postSave (mixed $success, mixed $exists) Executes internal events after save a record protected boolean _doLowInsert (Phalcon\Mvc\Model\MetaDataInterface $metaData, Phalcon\Db\AdapterInterface $connection, string | array $table, boolean | string $identityField) Sends a pre-build INSERT SQL statement to the relational database system protected boolean _doLowUpdate (Phalcon\Mvc\Model\MetaDataInterface $metaData, Phal- con\Db\AdapterInterface $connection, string | array $table) Sends a pre-build UPDATE SQL statement to the relational database system protected boolean _preSaveRelatedRecords (Phalcon\Db\AdapterInterface $connection, Phal- con\Mvc\ModelInterface[] $related)
Saves related records that must be stored prior to save the master record protected boolean _postSaveRelatedRecords (Phalcon\Db\AdapterInterface $connection, Phal- con\Mvc\ModelInterface[] $related) Save the related records assigned in the has-one/has-many relations public boolean save ([array $data], [array $whiteList]) Inserts or updates a model instance. Returning true on success or false otherwise.
// Updating a robot name $robot= Robots::findFirst("id = 100");
$robot->name="Biomass";
$robot->save();
public create ([mixed $data], [mixed $whiteList]) Inserts a model instance. If the instance already exists in the persistence it will throw an exception Returning true on success or false otherwise.
public update ([mixed $data], [mixed $whiteList]) Updates a model instance. If the instance doesn’t exist in the persistence it will throw an exception Returning true on success or false otherwise.
2.5. API 815 Phalcon PHP Framework Documentation, Release 3.1.1
// Updating a robot name $robot= Robots::findFirst("id = 100");
$robot->name="Biomass";
$robot->update(); public delete () Deletes a model instance. Returning true on success or false otherwise.
$robot= Robots::findFirst("id=100");
$robot->delete();
$robots= Robots::find("type = 'mechanical'"); foreach ($robots as $robot){ $robot->delete(); } public getOperationMade () Returns the type of the latest operation performed by the ORM Returns one of the OP_* class constants public refresh () Refreshes the model attributes re-querying the record from the database public skipOperation (mixed $skip) Skips the current operation forcing a success state public readAttribute (mixed $attribute) Reads an attribute value by its name
readAttribute("name"); public writeAttribute (mixed $attribute, mixed $value) Writes an attribute value by its name
$robot->writeAttribute("name","Rosey"); protected skipAttributes (array $attributes) Sets a list of attributes that must be skipped from the generated INSERT/UPDATE statement
class Robots extends \Phalcon\Mvc\Model { public function initialize() { $this->skipAttributes( [ "price", ] ); } } protected skipAttributesOnCreate (array $attributes) Sets a list of attributes that must be skipped from the generated INSERT statement
skipAttributesOnCreate( [ "created_at", ] ); } } protected skipAttributesOnUpdate (array $attributes) Sets a list of attributes that must be skipped from the generated UPDATE statement
skipAttributesOnUpdate( [ "modified_in", ] ); } } protected allowEmptyStringValues (array $attributes) Sets a list of attributes that must be skipped from the generated UPDATE statement
2.5. API 817 Phalcon PHP Framework Documentation, Release 3.1.1
class Robots extends \Phalcon\Mvc\Model { public function initialize() { $this->allowEmptyStringValues( [ "name", ] ); } } protected hasOne (mixed $fields, mixed $referenceModel, mixed $referencedFields, [mixed $options]) Setup a 1-1 relation between two models
hasOne("id","RobotsDescription","robots_id"); } } protected belongsTo (mixed $fields, mixed $referenceModel, mixed $referencedFields, [mixed $options]) Setup a reverse 1-1 or n-1 relation between two models
belongsTo("robots_id","Robots","id"); } } protected hasMany (mixed $fields, mixed $referenceModel, mixed $referencedFields, [mixed $options]) Setup a 1-n relation between two models
protected Phalcon\Mvc\Model\Relation hasManyToMany (string | array $fields, string $intermediateModel, string | array $intermediateFields, string | array $intermediateReferencedFields, mixed $referenceModel, string | array $ref- erencedFields, [array $options]) Setup an n-n relation between two models, through an intermediate relation
class Robots extends \Phalcon\Mvc\Model { public function initialize() { // Setup a many-to-many relation to Parts through RobotsParts $this->hasManyToMany( "id", "RobotsParts", "robots_id", "parts_id", "Parts", "id", ); } }
public addBehavior (Phalcon\Mvc\Model\BehaviorInterface $behavior) Setups a behavior in a model
use Phalcon\Mvc\Model; use Phalcon\Mvc\Model\Behavior\Timestampable;
class Robots extends Model { public function initialize() { $this->addBehavior( new Timestampable( [ "onCreate" =>[ "field" =>"created_at", "format" =>"Y-m-d", ], ] ) ); } }
protected keepSnapshots (mixed $keepSnapshot)
2.5. API 819 Phalcon PHP Framework Documentation, Release 3.1.1
Sets if the model must keep the original record snapshot in memory
keepSnapshots(true); } } public setSnapshotData (array $data, [array $columnMap]) Sets the record’s snapshot data. This method is used internally to set snapshot data when the model was set up to keep snapshot data public hasSnapshotData () Checks if the object has internal snapshot data public getSnapshotData () Returns the internal snapshot data public hasChanged ([string | array $fieldName]) Check if a specific attribute has changed This only works if the model is keeping data snapshots public getChangedFields () Returns a list of changed values.
$robots->getChangedFields(); print_r($robots->getChangedFields()); // ["deleted"] protected useDynamicUpdate (mixed $dynamicUpdate) Sets if a model must use dynamic update instead of the all-field update
} } public Phalcon\Mvc\Model\ResultsetInterface getRelated (string $alias, [array $arguments]) Returns related records based on defined relations protected mixed _getRelatedRecords (string $modelName, string $method, array $arguments) Returns related records defined relations depending on the method name final protected static Phalcon\Mvc\ModelInterface[] | Phalcon\Mvc\ModelInterface | boolean _invokeFinder (string $method, array $arguments) Try to check if the query must invoke a finder public mixed __call (string $method, array $arguments) Handles method calls when a method is not implemented public static mixed __callStatic (string $method, array $arguments) Handles method calls when a static method is not implemented public __set (string $property, mixed $value) Magic method to assign values to the the model final protected string _possibleSetter (string $property, mixed $value) Check for, and attempt to use, possible setter. public Phalcon\Mvc\Model\Resultset | Phalcon\Mvc\Model __get (string $property) Magic method to get related records using the relation alias as a property public __isset (mixed $property) Magic method to check if a property is a valid relation public serialize () Serializes the object ignoring connections, services, related objects or static properties public unserialize (mixed $data) Unserializes the object from a serialized string public dump () Returns a simple representation of the object that can be used with var_dump
dump() ); public array toArray ([array $columns]) Returns the instance as an array representation
toArray() );
2.5. API 821 Phalcon PHP Framework Documentation, Release 3.1.1
public array jsonSerialize () Serializes the object for json_encode
Abstract class Phalcon\Mvc\Model\Behavior implements Phalcon\Mvc\Model\BehaviorInterface This is an optional base class for ORM behaviors
Methods public __construct ([array $options]) protected mustTakeAction (mixed $eventName) Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) Returns the behavior options related to an event public notify (mixed $type, Phalcon\Mvc\ModelInterface $model) This method receives the notifications from the EventsManager public missingMethod (Phalcon\Mvc\ModelInterface $model, string $method, [array $arguments]) Acts as fallbacks when a missing method is called on the model
Class Phalcon\Mvc\Model\Behavior\SoftDelete extends abstract class Phalcon\Mvc\Model\Behavior implements Phalcon\Mvc\Model\BehaviorInterface Instead of permanently delete a record it marks the record as deleted changing the value of a flag column
Methods public notify (mixed $type, Phalcon\Mvc\ModelInterface $model) Listens for notifications from the models manager public __construct ([array $options]) inherited from Phalcon\Mvc\Model\Behavior
Phalcon\Mvc\Model\Behavior protected mustTakeAction (mixed $eventName) inherited from Phalcon\Mvc\Model\Behavior Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) inherited from Phalcon\Mvc\Model\Behavior Returns the behavior options related to an event public missingMethod (Phalcon\Mvc\ModelInterface $model, string $method, [array $arguments]) inherited from Phalcon\Mvc\Model\Behavior Acts as fallbacks when a missing method is called on the model
Class Phalcon\Mvc\Model\Behavior\Timestampable extends abstract class Phalcon\Mvc\Model\Behavior implements Phalcon\Mvc\Model\BehaviorInterface Allows to automatically update a model’s attribute saving the datetime when a record is created or updated
Methods public notify (mixed $type, Phalcon\Mvc\ModelInterface $model) Listens for notifications from the models manager public __construct ([array $options]) inherited from Phalcon\Mvc\Model\Behavior Phalcon\Mvc\Model\Behavior protected mustTakeAction (mixed $eventName) inherited from Phalcon\Mvc\Model\Behavior Checks whether the behavior must take action on certain event protected array getOptions ([string $eventName]) inherited from Phalcon\Mvc\Model\Behavior Returns the behavior options related to an event public missingMethod (Phalcon\Mvc\ModelInterface $model, string $method, [array $arguments]) inherited from Phalcon\Mvc\Model\Behavior Acts as fallbacks when a missing method is called on the model
Class Phalcon\Mvc\Model\Criteria implements Phalcon\Mvc\Model\CriteriaInterface, Phalcon\Di\InjectionAwareInterface This class is used to build the array parameter required by Phalcon\Mvc\Model::find() and Phal- con\Mvc\Model::findFirst() using an object-oriented interface.
2.5. API 823 Phalcon PHP Framework Documentation, Release 3.1.1
->orderBy("name") ->execute();
Methods
public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public setModelName (mixed $modelName) Set a model on which the query will be executed public getModelName () Returns an internal model name on which the criteria will be applied public bind (array $bindParams, [mixed $merge]) Sets the bound parameters in the criteria This method replaces all previously set bound parameters public bindTypes (array $bindTypes) Sets the bind types in the criteria This method replaces all previously set bound parameters public distinct (mixed $distinct) Sets SELECT DISTINCT / SELECT ALL flag public Phalcon\Mvc\Model\Criteria columns (string | array $columns) Sets the columns to be queried
$criteria->columns( [ "id", "name", ] );
public join (mixed $model, [mixed $conditions], [mixed $alias], [mixed $type]) Adds an INNER join to the query
$criteria->innerJoin("Robots"); $criteria->innerJoin("Robots","r.id = RobotsParts.robots_id"); $criteria->innerJoin("Robots","r.id = RobotsParts.robots_id","r"); public leftJoin (mixed $model, [mixed $conditions], [mixed $alias]) Adds a LEFT join to the query
$criteria->leftJoin("Robots","r.id = RobotsParts.robots_id","r"); public rightJoin (mixed $model, [mixed $conditions], [mixed $alias]) Adds a RIGHT join to the query
$criteria->rightJoin("Robots","r.id = RobotsParts.robots_id","r"); public where (mixed $conditions, [mixed $bindParams], [mixed $bindTypes]) Sets the conditions parameter in the criteria public addWhere (mixed $conditions, [mixed $bindParams], [mixed $bindTypes]) Appends a condition to the current conditions using an AND operator (deprecated) public andWhere (mixed $conditions, [mixed $bindParams], [mixed $bindTypes]) Appends a condition to the current conditions using an AND operator public orWhere (mixed $conditions, [mixed $bindParams], [mixed $bindTypes]) Appends a condition to the current conditions using an OR operator public betweenWhere (mixed $expr, mixed $minimum, mixed $maximum) Appends a BETWEEN condition to the current conditions
$criteria->betweenWhere("price", 100.25, 200.50); public notBetweenWhere (mixed $expr, mixed $minimum, mixed $maximum) Appends a NOT BETWEEN condition to the current conditions
$criteria->notBetweenWhere("price", 100.25, 200.50); public inWhere (mixed $expr, array $values) Appends an IN condition to the current conditions
$criteria->inWhere("id",[1,2,3]);
2.5. API 825 Phalcon PHP Framework Documentation, Release 3.1.1 public notInWhere (mixed $expr, array $values) Appends a NOT IN condition to the current conditions
$criteria->notInWhere("id",[1,2,3]); public conditions (mixed $conditions) Adds the conditions parameter to the criteria public order (mixed $orderColumns) Adds the order-by parameter to the criteria (deprecated) public orderBy (mixed $orderColumns) Adds the order-by clause to the criteria public groupBy (mixed $group) Adds the group-by clause to the criteria public having (mixed $having) Adds the having clause to the criteria public limit (mixed $limit, [mixed $offset]) Adds the limit parameter to the criteria.
$criteria->limit(100); $criteria->limit(100, 200); $criteria->limit("100","200"); public forUpdate ([mixed $forUpdate]) Adds the “for_update” parameter to the criteria public sharedLock ([mixed $sharedLock]) Adds the “shared_lock” parameter to the criteria public cache (array $cache) Sets the cache options in the criteria This method replaces all previously set cache options public getWhere () Returns the conditions parameter in the criteria public string | array | null getColumns () Returns the columns to be queried public getConditions () Returns the conditions parameter in the criteria public int | array | null getLimit () Returns the limit parameter in the criteria, which will be an integer if limit was set without an offset, an array with ‘number’ and ‘offset’ keys if an offset was set with the limit, or null if limit has not been set. public getOrderBy ()
Returns the order clause in the criteria public getGroupBy () Returns the group clause in the criteria public getHaving () Returns the having clause in the criteria public array getParams () Returns all the parameters defined in the criteria public static fromInput (Phalcon\DiInterface $dependencyInjector, mixed $modelName, array $data, [mixed $oper- ator]) Builds a Phalcon\Mvc\Model\Criteria based on an input array like _POST public execute () Executes a find using the parameters built with the criteria
Class Phalcon\Mvc\Model\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception
2.5. API 827 Phalcon PHP Framework Documentation, Release 3.1.1
final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\Model\Manager
implements Phalcon\Mvc\Model\ManagerInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Events\EventsAwareInterface This components controls the initialization of models, keeping record of relations between the different models of the application. A ModelsManager is injected to a model via a Dependency Injector/Services Container such as Phalcon\Di.
use Phalcon\Di; use Phalcon\Mvc\Model\Manager as ModelsManager;
$di= new Di();
$di->set( "modelsManager", function() { return new ModelsManager(); } );
$robot= new Robots($di);
Methods
public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets a global events manager public getEventsManager () Returns the internal event manager public setCustomEventsManager (Phalcon\Mvc\ModelInterface $model, Phalcon\Events\ManagerInterface $eventsManager) Sets a custom events manager for a specific model public getCustomEventsManager (Phalcon\Mvc\ModelInterface $model) Returns a custom events manager related to a model public initialize (Phalcon\Mvc\ModelInterface $model)
Initializes a model in the model manager public isInitialized (mixed $modelName) Check whether a model is already initialized public getLastInitialized () Get last initialized model public load (mixed $modelName, [mixed $newInstance]) Loads a model throwing an exception if it doesn’t exist public setModelSource (Phalcon\Mvc\ModelInterface $model, mixed $source) Sets the mapped source for a model final public isVisibleModelProperty (Phalcon\Mvc\ModelInterface $model, mixed $property) Check whether a model property is declared as public.
$isPublic= $manager->isVisibleModelProperty( new Robots(), "name" ); public getModelSource (Phalcon\Mvc\ModelInterface $model) Returns the mapped source for a model public setModelSchema (Phalcon\Mvc\ModelInterface $model, mixed $schema) Sets the mapped schema for a model public getModelSchema (Phalcon\Mvc\ModelInterface $model) Returns the mapped schema for a model public setConnectionService (Phalcon\Mvc\ModelInterface $model, mixed $connectionService) Sets both write and read connection service for a model public setWriteConnectionService (Phalcon\Mvc\ModelInterface $model, mixed $connectionService) Sets write connection service for a model public setReadConnectionService (Phalcon\Mvc\ModelInterface $model, mixed $connectionService) Sets read connection service for a model public getReadConnection (Phalcon\Mvc\ModelInterface $model) Returns the connection to read data related to a model public getWriteConnection (Phalcon\Mvc\ModelInterface $model) Returns the connection to write data related to a model protected _getConnection (Phalcon\Mvc\ModelInterface $model, mixed $connectionServices) Returns the connection to read or write data related to a model depending on the connection services. public getReadConnectionService (Phalcon\Mvc\ModelInterface $model) Returns the connection service name used to read data related to a model public getWriteConnectionService (Phalcon\Mvc\ModelInterface $model)
2.5. API 829 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the connection service name used to write data related to a model public _getConnectionService (Phalcon\Mvc\ModelInterface $model, mixed $connectionServices) Returns the connection service name used to read or write data related to a model depending on the connection services public notifyEvent (mixed $eventName, Phalcon\Mvc\ModelInterface $model) Receives events generated in the models and dispatches them to an events-manager if available Notify the behaviors that are listening in the model public missingMethod (Phalcon\Mvc\ModelInterface $model, mixed $eventName, mixed $data) Dispatch an event to the listeners and behaviors This method expects that the endpoint listeners/behaviors returns true meaning that a least one was implemented public addBehavior (Phalcon\Mvc\ModelInterface $model, Phalcon\Mvc\Model\BehaviorInterface $behavior) Binds a behavior to a model public keepSnapshots (Phalcon\Mvc\ModelInterface $model, mixed $keepSnapshots) Sets if a model must keep snapshots public isKeepingSnapshots (Phalcon\Mvc\ModelInterface $model) Checks if a model is keeping snapshots for the queried records public useDynamicUpdate (Phalcon\Mvc\ModelInterface $model, mixed $dynamicUpdate) Sets if a model must use dynamic update instead of the all-field update public isUsingDynamicUpdate (Phalcon\Mvc\ModelInterface $model) Checks if a model is using dynamic update instead of all-field update public Phalcon\Mvc\Model\Relation addHasOne (Phalcon\Mvc\Model $model, mixed $fields, string $referenced- Model, mixed $referencedFields, [array $options]) Setup a 1-1 relation between two models public Phalcon\Mvc\Model\Relation addBelongsTo (Phalcon\Mvc\Model $model, mixed $fields, string $referenced- Model, mixed $referencedFields, [array $options]) Setup a relation reverse many to one between two models public addHasMany (Phalcon\Mvc\ModelInterface $model, mixed $fields, string $referencedModel, mixed $refer- encedFields, [array $options]) Setup a relation 1-n between two models public Phalcon\Mvc\Model\Relation addHasManyToMany (Phalcon\Mvc\ModelInterface $model, string $fields, string $intermediateModel, string $intermediateFields, string $intermediateReferencedFields, string $referenced- Model, string $referencedFields, [array $options]) Setups a relation n-m between two models public existsBelongsTo (mixed $modelName, mixed $modelRelation) Checks whether a model has a belongsTo relation with another model public existsHasMany (mixed $modelName, mixed $modelRelation) Checks whether a model has a hasMany relation with another model public existsHasOne (mixed $modelName, mixed $modelRelation) Checks whether a model has a hasOne relation with another model
public existsHasManyToMany (mixed $modelName, mixed $modelRelation) Checks whether a model has a hasManyToMany relation with another model public getRelationByAlias (mixed $modelName, mixed $alias) Returns a relation by its alias final protected _mergeFindParameters (mixed $findParamsOne, mixed $findParamsTwo) Merge two arrays of find parameters public Phalcon\Mvc\Model\Resultset\Simple | Phalcon\Mvc\Model\Resultset\Simple | int | false getRelationRecords (Phalcon\Mvc\Model\RelationInterface $relation, mixed $method, Phalcon\Mvc\ModelInterface $record, [mixed $pa- rameters]) Helper method to query records based on a relation definition public getReusableRecords (mixed $modelName, mixed $key) Returns a reusable object from the internal list public setReusableRecords (mixed $modelName, mixed $key, mixed $records) Stores a reusable record in the internal list public clearReusableObjects () Clears the internal reusable list public getBelongsToRecords (mixed $method, mixed $modelName, mixed $modelRelation, Phal- con\Mvc\ModelInterface $record, [mixed $parameters]) Gets belongsTo related records from a model public getHasManyRecords (mixed $method, mixed $modelName, mixed $modelRelation, Phal- con\Mvc\ModelInterface $record, [mixed $parameters]) Gets hasMany related records from a model public getHasOneRecords (mixed $method, mixed $modelName, mixed $modelRelation, Phal- con\Mvc\ModelInterface $record, [mixed $parameters]) Gets belongsTo related records from a model public getBelongsTo (Phalcon\Mvc\ModelInterface $model) Gets all the belongsTo relations defined in a model
$relations= $modelsManager->getBelongsTo( new Robots() );
public getHasMany (Phalcon\Mvc\ModelInterface $model) Gets hasMany relations defined on a model public getHasOne (Phalcon\Mvc\ModelInterface $model) Gets hasOne relations defined on a model public getHasManyToMany (Phalcon\Mvc\ModelInterface $model) Gets hasManyToMany relations defined on a model public getHasOneAndHasMany (Phalcon\Mvc\ModelInterface $model)
2.5. API 831 Phalcon PHP Framework Documentation, Release 3.1.1
Gets hasOne relations defined on a model public getRelations (mixed $modelName) Query all the relationships defined on a model public getRelationsBetween (mixed $first, mixed $second) Query the first relationship defined between two models public createQuery (mixed $phql) Creates a Phalcon\Mvc\Model\Query without execute it public executeQuery (mixed $phql, [mixed $placeholders], [mixed $types]) Creates a Phalcon\Mvc\Model\Query and execute it public createBuilder ([mixed $params]) Creates a Phalcon\Mvc\Model\Query\Builder public getLastQuery () Returns the last query created or executed in the models manager public registerNamespaceAlias (mixed $alias, mixed $namespaceName) Registers shorter aliases for namespaces in PHQL statements public getNamespaceAlias (mixed $alias) Returns a real namespace from its alias public getNamespaceAliases () Returns all the registered namespace aliases public __destruct () Destroys the current PHQL cache
Class Phalcon\Mvc\Model\Message implements Phalcon\Mvc\Model\MessageInterface Encapsulates validation info generated before save/delete records fails
name ==="Peter"){ $text="A robot cannot be named Peter"; $field="name"; $type="InvalidValue";
Methods public __construct (string $message, [string | array $field], [string $type], [Phalcon\Mvc\ModelInterface $model], [int | null $code]) Phalcon\Mvc\Model\Message constructor public setType (mixed $type) Sets message type public getType () Returns message type public setMessage (mixed $message) Sets verbose message public getMessage () Returns verbose message public setField (mixed $field) Sets field name related to message public getField () Returns field name related to message public setModel (Phalcon\Mvc\ModelInterface $model) Set the model who generates the message public setCode (mixed $code) Sets code for the message public getModel () Returns the model that produced the message public getCode () Returns the message code public __toString () Magic __toString method returns verbose message public static __set_state (array $message) Magic __set_state helps to re-build messages variable exporting
Abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Di\InjectionAwareInterface, Phalcon\Mvc\Model\MetaDataInterface
2.5. API 833 Phalcon PHP Framework Documentation, Release 3.1.1
Because Phalcon\Mvc\Model requires meta-data like field names, data types, primary keys, etc. this component collect them and store for further querying by Phalcon\Mvc\Model. Phalcon\Mvc\Model\MetaData can also use adapters to store temporarily or permanently the meta-data. A standard Phalcon\Mvc\Model\MetaData can be used to query model attributes:
$metaData= new \Phalcon\Mvc\Model\MetaData\Memory();
$attributes= $metaData->getAttributes( new Robots() );
final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container
834 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) Set the meta-data extraction strategy public getStrategy () Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) Reads the complete meta-data for certain model
readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) Reads meta-data for certain model
readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) Writes meta-data for certain model using a MODEL_* constant
writeColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP, [ "leName" =>"name", ] ) );
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) Reads the ordered/reversed column map for certain model
readColumnMap( new Robots() ) );
2.5. API 835 Phalcon PHP Framework Documentation, Release 3.1.1
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) Returns an array of fields which are not part of the primary key
getNonPrimaryKeyAttributes( new Robots() ) ); public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) Returns an array of not null attributes
public getDataTypes (Phalcon\Mvc\ModelInterface $model) Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
2.5. API 837 Phalcon PHP Framework Documentation, Release 3.1.1
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots()
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () Checks if the internal meta-data container is empty
var_dump(
2.5. API 839 Phalcon PHP Framework Documentation, Release 3.1.1
$metaData->isEmpty() ); public reset () Resets internal meta-data in order to regenerate it
$metaData->reset(); abstract public read (mixed $key) inherited from Phalcon\Mvc\Model\MetaDataInterface ... abstract public write (mixed $key, mixed $data) inherited from Phalcon\Mvc\Model\MetaDataInterface ...
Class Phalcon\Mvc\Model\MetaData\Apc extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in the APC cache. Data will erased if the web server is restarted By default meta-data is stored for 48 hours (172800 seconds) You can query the meta-data by printing apc_fetch(‘$PMM$’) or apc_fetch(‘$PMM$my-app-id’)
public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Apc constructor public read (mixed $key) Reads meta-data from APC public write (mixed $key, mixed $data) Writes the meta-data to APC final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
2.5. API 841 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
print_r( $metaData->readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
print_r( $metaData->readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) );
public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
print_r( $metaData->getPrimaryKeyAttributes( new Robots() ) );
public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
print_r( $metaData->getNonPrimaryKeyAttributes( new Robots() ) );
public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
print_r( $metaData->getNotNullAttributes( new Robots() ) );
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
2.5. API 843 Phalcon PHP Framework Documentation, Release 3.1.1
getDataTypesNumeric( new Robots() ) ); public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
getIdentityField( new Robots() ) ); public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
getBindTypes( new Robots() ) ); public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
getAutomaticCreateAttributes( new Robots() ) ); public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
2.5. API 845 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
public reset () inherited from Phalcon\Mvc\Model\MetaData Resets internal meta-data in order to regenerate it
Class Phalcon\Mvc\Model\MetaData\Files extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in PHP files.
$metaData= new \Phalcon\Mvc\Model\Metadata\Files( [ "metaDataDir" =>"app/cache/metadata/", ] );
Methods public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Files constructor
2.5. API 847 Phalcon PHP Framework Documentation, Release 3.1.1
public mixed read (string $key) Reads meta-data from files public write (string $key, array $data) Writes the meta-data to files final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
$metaData->writeColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP, [ "leName" =>"name", ] ) );
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) );
2.5. API 849 Phalcon PHP Framework Documentation, Release 3.1.1
public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
print_r( $metaData->getNonPrimaryKeyAttributes( new Robots() ) );
public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
print_r( $metaData->getNotNullAttributes( new Robots() ) );
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes(
2.5. API 851 Phalcon PHP Framework Documentation, Release 3.1.1
new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
public reset () inherited from Phalcon\Mvc\Model\MetaData Resets internal meta-data in order to regenerate it
$metaData->reset();
Class Phalcon\Mvc\Model\MetaData\Libmemcached
extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in the Memcache. By default meta-data is stored for 48 hours (172800 seconds)
$metaData= new Phalcon\Mvc\Model\Metadata\Libmemcached( [ "servers" =>[ [ "host" =>"localhost",
2.5. API 853 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Libmemcached constructor public read (mixed $key) Reads metadata from Memcache public write (mixed $key, mixed $data) Writes the metadata to Memcache public reset ()
Flush Memcache data and resets internal meta-data in order to regenerate it final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
print_r( $metaData->writeColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP, [ "leName" =>"name",
2.5. API 855 Phalcon PHP Framework Documentation, Release 3.1.1
] ) );
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
print_r( $metaData->getNonPrimaryKeyAttributes( new Robots() ) );
public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
print_r( $metaData->getNotNullAttributes( new Robots() ) );
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
2.5. API 857 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true,
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
2.5. API 859 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
Class Phalcon\Mvc\Model\MetaData\Memcache
extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in the Memcache. By default meta-data is stored for 48 hours (172800 seconds)
Methods public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Memcache constructor public read (mixed $key) Reads metadata from Memcache public write (mixed $key, mixed $data) Writes the metadata to Memcache public reset () Flush Memcache data and resets internal meta-data in order to regenerate it final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData
2.5. API 861 Phalcon PHP Framework Documentation, Release 3.1.1
Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
print_r( $metaData->readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
getNonPrimaryKeyAttributes( new Robots() ) ); public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
getNotNullAttributes( new Robots() ) );
2.5. API 863 Phalcon PHP Framework Documentation, Release 3.1.1
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
2.5. API 865 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
Class Phalcon\Mvc\Model\MetaData\Memory
extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in memory. Data will be erased when the request finishes
public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Memory constructor public array read (string $key) Reads the meta-data from temporal memory
2.5. API 867 Phalcon PHP Framework Documentation, Release 3.1.1
public write (string $key, array $data) Writes the meta-data to temporal memory final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
print_r( $metaData->writeColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP, [
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
2.5. API 869 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getNonPrimaryKeyAttributes( new Robots() ) );
public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
print_r( $metaData->getNotNullAttributes( new Robots() ) );
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true,
2.5. API 871 Phalcon PHP Framework Documentation, Release 3.1.1
] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
public reset () inherited from Phalcon\Mvc\Model\MetaData Resets internal meta-data in order to regenerate it
$metaData->reset();
Class Phalcon\Mvc\Model\MetaData\Redis
extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in the Redis. By default meta-data is stored for 48 hours (172800 seconds)
use Phalcon\Mvc\Model\Metadata\Redis;
$metaData= new Redis( [ "host" =>"127.0.0.1", "port" => 6379,
2.5. API 873 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Redis constructor public read (mixed $key) Reads metadata from Redis public write (mixed $key, mixed $data) Writes the metadata to Redis public reset () Flush Redis data and resets internal meta-data in order to regenerate it final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
2.5. API 875 Phalcon PHP Framework Documentation, Release 3.1.1
readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
print_r( $metaData->getNotNullAttributes( new Robots() ) );
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
2.5. API 877 Phalcon PHP Framework Documentation, Release 3.1.1
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
2.5. API 879 Phalcon PHP Framework Documentation, Release 3.1.1
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
Class Phalcon\Mvc\Model\MetaData\Session
extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in session. Data will erased when the session finishes. Meta-data are permanent while the session is active. You can query the meta-data by printing $_SESSION[’$PMM$’]
$metaData= new \Phalcon\Mvc\Model\Metadata\Session( [ "prefix" =>"my-app-id", ] );
public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Session constructor public array read (string $key) Reads meta-data from $_SESSION public write (string $key, array $data) Writes the meta-data to $_SESSION final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
2.5. API 881 Phalcon PHP Framework Documentation, Release 3.1.1
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
print_r( $metaData->readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
print_r( $metaData->readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) );
public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
getNonPrimaryKeyAttributes( new Robots() ) ); public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
getNotNullAttributes( new Robots() ) ); public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
getDataTypes( new Robots() ) ); public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData
2.5. API 883 Phalcon PHP Framework Documentation, Release 3.1.1
Returns attributes which types are numerical
getDataTypesNumeric( new Robots() ) ); public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
getIdentityField( new Robots() ) ); public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
getBindTypes( new Robots() ) ); public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
getAutomaticCreateAttributes( new Robots() ) ); public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
2.5. API 885 Phalcon PHP Framework Documentation, Release 3.1.1
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
public reset () inherited from Phalcon\Mvc\Model\MetaData Resets internal meta-data in order to regenerate it
Class Phalcon\Mvc\Model\MetaData\Strategy\Annotations implements Phalcon\Mvc\Model\MetaData\StrategyInterface
Methods
final public getMetaData (Phalcon\Mvc\ModelInterface $model, Phalcon\DiInterface $dependencyInjector) The meta-data is obtained by reading the column descriptions from the database information schema final public getColumnMaps (Phalcon\Mvc\ModelInterface $model, Phalcon\DiInterface $dependencyInjector) Read the model’s column map, this can’t be inferred
Class Phalcon\Mvc\Model\MetaData\Strategy\Introspection implements Phalcon\Mvc\Model\MetaData\StrategyInterface Queries the table meta-data in order to introspect the model’s metadata
Methods
final public getMetaData (Phalcon\Mvc\ModelInterface $model, Phalcon\DiInterface $dependencyInjector) The meta-data is obtained by reading the column descriptions from the database information schema final public getColumnMaps (Phalcon\Mvc\ModelInterface $model, Phalcon\DiInterface $dependencyInjector) Read the model’s column map, this can’t be inferred
Class Phalcon\Mvc\Model\MetaData\Xcache extends abstract class Phalcon\Mvc\Model\MetaData implements Phalcon\Mvc\Model\MetaDataInterface, Phalcon\Di\InjectionAwareInterface Stores model meta-data in the XCache cache. Data will erased if the web server is restarted By default meta-data is stored for 48 hours (172800 seconds) You can query the meta-data by printing xcache_get(‘$PMM$’) or xcache_get(‘$PMM$my-app-id’)
public __construct ([array $options]) Phalcon\Mvc\Model\MetaData\Xcache constructor public array read (string $key) Reads metadata from XCache public write (string $key, array $data) Writes the metadata to XCache final protected _initialize (Phalcon\Mvc\ModelInterface $model, mixed $key, mixed $table, mixed $schema) inherited from Phalcon\Mvc\Model\MetaData Initialize the metadata for certain table public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Model\MetaData Sets the DependencyInjector container public getDI () inherited from Phalcon\Mvc\Model\MetaData Returns the DependencyInjector container public setStrategy (Phalcon\Mvc\Model\MetaData\StrategyInterface $strategy) inherited from Phal- con\Mvc\Model\MetaData Set the meta-data extraction strategy public getStrategy () inherited from Phalcon\Mvc\Model\MetaData
Return the strategy to obtain the meta-data final public readMetaData (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the complete meta-data for certain model
print_r( $metaData->readMetaData( new Robots() ) );
final public readMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads meta-data for certain model
print_r( $metaData->readMetaDataIndex( new Robots(), 0 ) );
final public writeMetaDataIndex (Phalcon\Mvc\ModelInterface $model, mixed $index, mixed $data) inherited from Phalcon\Mvc\Model\MetaData Writes meta-data for certain model using a MODEL_* constant
final public readColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Reads the ordered/reversed column map for certain model
print_r( $metaData->readColumnMap( new Robots() ) );
final public readColumnMapIndex (Phalcon\Mvc\ModelInterface $model, mixed $index) inherited from Phal- con\Mvc\Model\MetaData Reads column-map information for certain model using a MODEL_* constant
2.5. API 889 Phalcon PHP Framework Documentation, Release 3.1.1
readColumnMapIndex( new Robots(), MetaData::MODELS_REVERSE_COLUMN_MAP ) ); public getAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns table attributes names (fields)
getAttributes( new Robots() ) ); public getPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are part of the primary key
getPrimaryKeyAttributes( new Robots() ) ); public getNonPrimaryKeyAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns an array of fields which are not part of the primary key
getNonPrimaryKeyAttributes( new Robots() ) ); public getNotNullAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns an array of not null attributes
public getDataTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their data types
print_r( $metaData->getDataTypes( new Robots() ) );
public getDataTypesNumeric (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes which types are numerical
print_r( $metaData->getDataTypesNumeric( new Robots() ) );
public string getIdentityField (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the name of identity field (if one is present)
print_r( $metaData->getIdentityField( new Robots() ) );
public getBindTypes (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes and their bind data types
print_r( $metaData->getBindTypes( new Robots() ) );
public getAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the INSERT SQL generation
print_r( $metaData->getAutomaticCreateAttributes( new Robots() ) );
2.5. API 891 Phalcon PHP Framework Documentation, Release 3.1.1
public getAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes that must be ignored from the UPDATE SQL generation
print_r( $metaData->getAutomaticUpdateAttributes( new Robots() ) );
public setAutomaticCreateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the INSERT SQL generation
$metaData->setAutomaticCreateAttributes( new Robots(), [ "created_at" => true, ] );
public setAutomaticUpdateAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that must be ignored from the UPDATE SQL generation
$metaData->setAutomaticUpdateAttributes( new Robots(), [ "modified_at" => true, ] );
public setEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model, array $attributes) inherited from Phal- con\Mvc\Model\MetaData Set the attributes that allow empty string values
$metaData->setEmptyStringAttributes( new Robots(), [ "name" => true, ] );
public getEmptyStringAttributes (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns attributes allow empty strings
print_r( $metaData->getEmptyStringAttributes( new Robots() ) );
public getDefaultValues (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns attributes (which have default values) and their default values
print_r( $metaData->getDefaultValues( new Robots() ) );
public getColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phalcon\Mvc\Model\MetaData Returns the column map if any
print_r( $metaData->getColumnMap( new Robots() ) );
public getReverseColumnMap (Phalcon\Mvc\ModelInterface $model) inherited from Phal- con\Mvc\Model\MetaData Returns the reverse column map if any
print_r( $metaData->getReverseColumnMap( new Robots() ) );
public hasAttribute (Phalcon\Mvc\ModelInterface $model, mixed $attribute) inherited from Phal- con\Mvc\Model\MetaData Check if a model has certain attribute
var_dump( $metaData->hasAttribute( new Robots(), "name" ) );
2.5. API 893 Phalcon PHP Framework Documentation, Release 3.1.1
public isEmpty () inherited from Phalcon\Mvc\Model\MetaData Checks if the internal meta-data container is empty
var_dump( $metaData->isEmpty() );
public reset () inherited from Phalcon\Mvc\Model\MetaData Resets internal meta-data in order to regenerate it
$metaData->reset();
Class Phalcon\Mvc\Model\Query
implements Phalcon\Mvc\Model\QueryInterface, Phalcon\Di\InjectionAwareInterface This class takes a PHQL intermediate representation and executes it.
$phql="SELECT c.price *0.16 AS taxes, c.* FROM Cars AS c JOIN Brands AS b WHERE b.name = :name: ORDER BY c.name";
Phalcon\Mvc\Model\Query constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injection container public getDI () Returns the dependency injection container public setUniqueRow (mixed $uniqueRow) Tells to the query if only the first row in the resultset must be returned public getUniqueRow () Check if the query is programmed to get only the first row in the resultset final protected _getQualified (array $expr) Replaces the model’s name to its source name in a qualified-name expression final protected _getCallArgument (array $argument) Resolves an expression in a single call argument final protected _getCaseExpression (array $expr) Resolves an expression in a single call argument final protected _getFunctionCall (array $expr) Resolves an expression in a single call argument final protected string _getExpression (array $expr, [boolean $quoting]) Resolves an expression from its intermediate code into a string final protected _getSelectColumn (array $column) Resolves a column from its intermediate representation into an array used to determine if the resultset produced is simple or complex final protected string _getTable (Phalcon\Mvc\Model\ManagerInterface $manager, array $qualifiedName) Resolves a table in a SELECT statement checking if the model exists final protected _getJoin (Phalcon\Mvc\Model\ManagerInterface $manager, mixed $join) Resolves a JOIN clause checking if the associated models exist final protected string _getJoinType (array $join) Resolves a JOIN type final protected array _getSingleJoin (string $joinType, string $joinSource, string $modelAlias, string $joinAlias, Phalcon\Mvc\Model\RelationInterface $relation) Resolves joins involving has-one/belongs-to/has-many relations final protected array _getMultiJoin (string $joinType, string $joinSource, string $modelAlias, string $joinAlias, Phalcon\Mvc\Model\RelationInterface $relation) Resolves joins involving many-to-many relations final protected array _getJoins (array $select) Processes the JOINs in the query returning an internal representation for the database dialect final protected array _getOrderClause (array | string $order)
2.5. API 895 Phalcon PHP Framework Documentation, Release 3.1.1
Returns a processed order clause for a SELECT statement final protected _getGroupClause (array $group) Returns a processed group clause for a SELECT statement final protected _getLimitClause (array $limitClause) Returns a processed limit clause for a SELECT statement final protected _prepareSelect ([mixed $ast], [mixed $merge]) Analyzes a SELECT intermediate code and produces an array to be executed later final protected _prepareInsert () Analyzes an INSERT intermediate code and produces an array to be executed later final protected _prepareUpdate () Analyzes an UPDATE intermediate code and produces an array to be executed later final protected _prepareDelete () Analyzes a DELETE intermediate code and produces an array to be executed later public parse () Parses the intermediate code produced by Phalcon\Mvc\Model\Query\Lang generating another intermediate represen- tation that could be executed by Phalcon\Mvc\Model\Query public getCache () Returns the current cache backend instance final protected _executeSelect (mixed $intermediate, mixed $bindParams, mixed $bindTypes, [mixed $simulate]) Executes the SELECT intermediate representation producing a Phalcon\Mvc\Model\Resultset final protected Phalcon\Mvc\Model\Query\StatusInterface _executeInsert (array $intermediate, array $bindParams, array $bindTypes) Executes the INSERT intermediate representation producing a Phalcon\Mvc\Model\Query\Status final protected Phalcon\Mvc\Model\Query\StatusInterface _executeUpdate (array $intermediate, array $bindParams, array $bindTypes) Executes the UPDATE intermediate representation producing a Phalcon\Mvc\Model\Query\Status final protected Phalcon\Mvc\Model\Query\StatusInterface _executeDelete (array $intermediate, array $bindParams, array $bindTypes) Executes the DELETE intermediate representation producing a Phalcon\Mvc\Model\Query\Status final protected Phalcon\Mvc\Model\ResultsetInterface _getRelatedRecords (Phalcon\Mvc\ModelInterface $model, array $intermediate, array $bindParams, array $bindTypes) Query the records on which the UPDATE/DELETE operation well be done public mixed execute ([array $bindParams], [array $bindTypes]) Executes a parsed PHQL statement public Phalcon\Mvc\ModelInterface getSingleResult ([array $bindParams], [array $bindTypes]) Executes the query returning the first result public setType (mixed $type) Sets the type of PHQL statement to be executed
896 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public getType () Gets the type of PHQL statement executed public setBindParams (array $bindParams, [mixed $merge]) Set default bind parameters public array getBindParams () Returns default bind params public setBindTypes (array $bindTypes, [mixed $merge]) Set default bind parameters public setSharedLock ([mixed $sharedLock]) Set SHARED LOCK clause public array getBindTypes () Returns default bind types public setIntermediate (array $intermediate) Allows to set the IR to be executed public array getIntermediate () Returns the intermediate representation of the PHQL statement public cache (mixed $cacheOptions) Sets the cache parameters of the query public getCacheOptions () Returns the current cache options public getSql () Returns the SQL to be generated by the internal PHQL (only works in SELECT statements) public static clean () Destroys the internal PHQL cache
Class Phalcon\Mvc\Model\Query\Builder implements Phalcon\Mvc\Model\Query\BuilderInterface, Phalcon\Di\InjectionAwareInterface Helps to create PHQL queries using an OO interface
$queryBuilder= new \Phalcon\Mvc\Model\Query\Builder($params);
Constants
string OPERATOR_OR string OPERATOR_AND
Methods
public __construct ([mixed $params], [Phalcon\DiInterface $dependencyInjector]) Phalcon\Mvc\Model\Query\Builder constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public distinct (mixed $distinct) Sets SELECT DISTINCT / SELECT ALL flag
$builder->columns( [ "name", "number" =>"COUNT( *)", ] ); public string | array getColumns () Return the columns to be queried public from (mixed $models) Sets the models who makes part of the query
$builder->from("Robots");
$builder->from( [ "Robots", "RobotsParts", ] );
$builder->from( [ "r" =>"Robots", "rp" =>"RobotsParts", ] ); public addFrom (mixed $model, [mixed $alias], [mixed $with]) Add a model to take part of the query
// Load data from models Robots $builder->addFrom("Robots");
// Load data from model 'Robots' using 'r' as alias in PHQL $builder->addFrom("Robots","r");
// Load data from model 'Robots' using 'r' as alias in PHQL // and eager load model 'RobotsParts' $builder->addFrom("Robots","r","RobotsParts");
// Load data from model 'Robots' using 'r' as alias in PHQL // and eager load models 'RobotsParts' and 'Parts' $builder->addFrom( "Robots",
2.5. API 899 Phalcon PHP Framework Documentation, Release 3.1.1
"r", [ "RobotsParts", "Parts", ] ); public string | array getFrom () Return the models who makes part of the query public Phalcon\Mvc\Model\Query\Builder join (string $model, [string $conditions], [string $alias], [string $type]) Adds an INNER join to the query
// Inner Join model 'Robots' with automatic conditions and alias $builder->join("Robots");
// Inner Join model 'Robots' specifying conditions $builder->join("Robots","Robots.id = RobotsParts.robots_id");
// Inner Join model 'Robots' specifying conditions and alias $builder->join("Robots","r.id = RobotsParts.robots_id","r");
// Left Join model 'Robots' specifying conditions, alias and type of join $builder->join("Robots","r.id = RobotsParts.robots_id","r","LEFT"); public Phalcon\Mvc\Model\Query\Builder innerJoin (string $model, [string $conditions], [string $alias]) Adds an INNER join to the query
// Inner Join model 'Robots' with automatic conditions and alias $builder->innerJoin("Robots");
// Inner Join model 'Robots' specifying conditions $builder->innerJoin("Robots","Robots.id = RobotsParts.robots_id");
// Inner Join model 'Robots' specifying conditions and alias $builder->innerJoin("Robots","r.id = RobotsParts.robots_id","r"); public Phalcon\Mvc\Model\Query\Builder leftJoin (string $model, [string $conditions], [string $alias]) Adds a LEFT join to the query
$builder->leftJoin("Robots","r.id = RobotsParts.robots_id","r"); public Phalcon\Mvc\Model\Query\Builder rightJoin (string $model, [string $conditions], [string $alias]) Adds a RIGHT join to the query
900 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public array getJoins () Return join parts of the query public Phalcon\Mvc\Model\Query\Builder where (mixed $conditions, [array $bindParams], [array $bindTypes]) Sets the query conditions
$builder->where(100);
$builder->where("name = 'Peter'");
$builder->where( "name = :name: AND id > :id:", [ "name" =>"Peter", "id" => 100, ] ); public Phalcon\Mvc\Model\Query\Builder andWhere (string $conditions, [array $bindParams], [array $bindTypes]) Appends a condition to the current conditions using a AND operator
$builder->andWhere("name = 'Peter'");
$builder->andWhere( "name = :name: AND id > :id:", [ "name" =>"Peter", "id" => 100, ] ); public Phalcon\Mvc\Model\Query\Builder orWhere (string $conditions, [array $bindParams], [array $bindTypes]) Appends a condition to the current conditions using an OR operator
$builder->orWhere("name = 'Peter'");
$builder->orWhere( "name = :name: AND id > :id:", [ "name" =>"Peter", "id" => 100, ] ); public betweenWhere (mixed $expr, mixed $minimum, mixed $maximum, [mixed $operator]) Appends a BETWEEN condition to the current conditions
$builder->betweenWhere("price", 100.25, 200.50);
2.5. API 901 Phalcon PHP Framework Documentation, Release 3.1.1
public notBetweenWhere (mixed $expr, mixed $minimum, mixed $maximum, [mixed $operator]) Appends a NOT BETWEEN condition to the current conditions
public inWhere (mixed $expr, array $values, [mixed $operator]) Appends an IN condition to the current conditions
$builder->inWhere("id",[1,2,3]);
public notInWhere (mixed $expr, array $values, [mixed $operator]) Appends a NOT IN condition to the current conditions
$builder->notInWhere("id",[1,2,3]);
public string | array getWhere () Return the conditions for the query public Phalcon\Mvc\Model\Query\Builder orderBy (string | array $orderBy) Sets an ORDER BY condition clause
public string | array getOrderBy () Returns the set ORDER BY clause public having (mixed $having) Sets a HAVING condition clause. You need to escape PHQL reserved words using [ and ] delimiters
$builder->having("SUM(Robots.price) > 0");
public forUpdate (mixed $forUpdate) Sets a FOR UPDATE clause
$builder->forUpdate(true);
public string | array getHaving () Return the current having clause public limit (mixed $limit, [mixed $offset])
public string | array getLimit () Returns the current LIMIT clause public offset (mixed $offset) Sets an OFFSET clause
$builder->offset(30);
public string | array getOffset () Returns the current OFFSET clause public Phalcon\Mvc\Model\Query\Builder groupBy (string | array $group) Sets a GROUP BY clause
$builder->groupBy( [ "Robots.name", ] );
public string getGroupBy () Returns the GROUP BY clause final public string getPhql () Returns a PHQL statement built based on the builder parameters public getQuery () Returns the query built final public autoescape (mixed $identifier) Automatically escapes identifiers but only if they need to be escaped.
Abstract class Phalcon\Mvc\Model\Query\Lang
PHQL is implemented as a parser (written in C) that translates syntax in that of the target RDBMS. It allows Phalcon to offer a unified SQL language to the developer, while internally doing all the work of translating PHQL instructions to the most optimal SQL instructions depending on the RDBMS type associated with a model. To achieve the highest performance possible, we wrote a parser that uses the same technology as SQLite. This tech- nology provides a small in-memory parser with a very low memory footprint that is also thread-safe.
2.5. API 903 Phalcon PHP Framework Documentation, Release 3.1.1
$intermediate= Phalcon\Mvc\Model\Query\Lang::parsePHQL("SELECT r. * FROM Robots r ˓→LIMIT 10");
Methods public static string parsePHQL (string $phql) Parses a PHQL statement returning an intermediate representation (IR)
Class Phalcon\Mvc\Model\Query\Status implements Phalcon\Mvc\Model\Query\StatusInterface This class represents the status returned by a PHQL statement like INSERT, UPDATE or DELETE. It offers context information and the related messages produced by the model which finally executes the operations when it fails
$phql="UPDATE Robots SET name = :name:, type = :type:, year = :year: WHERE id = :id:
// Check if the update was successful if ($status->success() === true){ echo "OK"; }
Methods public __construct (mixed $success, [Phalcon\Mvc\ModelInterface $model]) public getModel () Returns the model that executed the action public getMessages () Returns the messages produced because of a failed operation public success () Allows to check if the executed operation was successful
Methods public __construct (int $type, string $referencedModel, string | array $fields, string | array $referencedFields, [array $options]) Phalcon\Mvc\Model\Relation constructor public setIntermediateRelation (string | array $intermediateFields, string $intermediateModel, string $intermedi- ateReferencedFields) Sets the intermediate model data for has-*-through relations public getType () Returns the relation type public getReferencedModel () Returns the referenced model public string | array getFields () Returns the fields public string | array getReferencedFields () Returns the referenced fields public string | array getOptions () Returns the options public getOption (mixed $name) Returns an option by the specified name If the option doesn’t exist null is returned public isForeignKey () Check whether the relation act as a foreign key public string | array getForeignKey ()
2.5. API 905 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the foreign key configuration public array getParams () Returns parameters that must be always used when the related records are obtained public isThrough () Check whether the relation is a ‘many-to-many’ relation or not public isReusable () Check if records returned by getting belongs-to/has-many are implicitly cached during the current request public string | array getIntermediateFields () Gets the intermediate fields for has-*-through relations public getIntermediateModel () Gets the intermediate model for has-*-through relations public string | array getIntermediateReferencedFields () Gets the intermediate referenced fields for has-*-through relations
Abstract class Phalcon\Mvc\Model\Resultset implements Phalcon\Mvc\Model\ResultsetInterface, Iterator, Traversable, SeekableIterator, Countable, ArrayAccess, Serializable, JsonSerializable This component allows to Phalcon\Mvc\Model returns large resultsets with the minimum memory consumption Re- sultsets can be traversed using a standard foreach or a while statement. If a resultset is serialized it will dump all the rows into a big array. Then unserialize will retrieve the rows as they were before serializing.
// Using a standard foreach $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", ] ); foreach ($robots as robot) { echo robot->name," \n"; }
// Using a while $robots= Robots::find( [ "type = 'virtual'", "order" =>"name", ] );
$robots->rewind(); while ($robots->valid()) { $robot= $robots->current();
Methods public __construct (Phalcon\Db\ResultInterface | false $result, [Phalcon\Cache\BackendInterface $cache]) Phalcon\Mvc\Model\Resultset constructor public next () Moves cursor to next row in the resultset public valid () Check whether internal resource has rows to fetch public key () Gets pointer number of active row in the resultset final public rewind () Rewinds resultset to its beginning final public seek (mixed $position) Changes internal pointer to a specific position in the resultset Set new position if required and set this->_row final public count () Counts how many rows are in the resultset public offsetExists (mixed $index) Checks whether offset exists in the resultset public offsetGet (mixed $index) Gets row in a specific position of the resultset public offsetSet (int $index, Phalcon\Mvc\ModelInterface $value) Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public offsetUnset (mixed $offset) Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public getType ()
2.5. API 907 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the internal type of data retrieval that the resultset is using public getFirst () Get first row in the resultset public getLast () Get last row in the resultset public setIsFresh (mixed $isFresh) Set if the resultset is fresh or an old one cached public isFresh () Tell if the resultset if fresh or an old one cached public setHydrateMode (mixed $hydrateMode) Sets the hydration mode in the resultset public getHydrateMode () Returns the current hydration mode public getCache () Returns the associated cache for the resultset public getMessages () Returns the error messages produced by a batch operation public boolean update (array $data, [Closure $conditionCallback]) Updates every record in the resultset public delete ([Closure $conditionCallback]) Deletes every record in the resultset public Phalcon\Mvc\Model[] filter (callback $filter) Filters a resultset returning only those the developer requires
$filtered= $robots->filter( function ($robot){ if ($robot->id<3){ return $robot; } } );
public array jsonSerialize () Returns serialised model objects as array for json_encode. Calls jsonSerialize on each object if present
908 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public toArray () inherited from Phalcon\Mvc\Model\ResultsetInterface ... abstract public current () inherited from Iterator ... abstract public serialize () inherited from Serializable ... abstract public unserialize (mixed $serialized) inherited from Serializable ...
Class Phalcon\Mvc\Model\Resultset\Complex extends abstract class Phalcon\Mvc\Model\Resultset implements JsonSerializable, Serializable, ArrayAccess, Countable, SeekableIterator, Traversable, Iterator, Phal- con\Mvc\Model\ResultsetInterface Complex resultsets may include complete objects and scalar values. This class builds every complex row as it is required
Methods public __construct (array $columnTypes, [Phalcon\Db\ResultInterface $result], [Phalcon\Cache\BackendInterface $cache]) Phalcon\Mvc\Model\Resultset\Complex constructor final public current () Returns current row in the resultset public toArray () Returns a complete resultset as an array, if the resultset has a big number of rows it could consume more memory than currently it does. public serialize () Serializing a resultset will dump all related rows into a big array public unserialize (mixed $data) Unserializing a resultset will allow to only works on the rows present in the saved state public next () inherited from Phalcon\Mvc\Model\Resultset
2.5. API 909 Phalcon PHP Framework Documentation, Release 3.1.1
Moves cursor to next row in the resultset public valid () inherited from Phalcon\Mvc\Model\Resultset Check whether internal resource has rows to fetch public key () inherited from Phalcon\Mvc\Model\Resultset Gets pointer number of active row in the resultset final public rewind () inherited from Phalcon\Mvc\Model\Resultset Rewinds resultset to its beginning final public seek (mixed $position) inherited from Phalcon\Mvc\Model\Resultset Changes internal pointer to a specific position in the resultset Set new position if required and set this->_row final public count () inherited from Phalcon\Mvc\Model\Resultset Counts how many rows are in the resultset public offsetExists (mixed $index) inherited from Phalcon\Mvc\Model\Resultset Checks whether offset exists in the resultset public offsetGet (mixed $index) inherited from Phalcon\Mvc\Model\Resultset Gets row in a specific position of the resultset public offsetSet (int $index, Phalcon\Mvc\ModelInterface $value) inherited from Phalcon\Mvc\Model\Resultset Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public offsetUnset (mixed $offset) inherited from Phalcon\Mvc\Model\Resultset Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public getType () inherited from Phalcon\Mvc\Model\Resultset Returns the internal type of data retrieval that the resultset is using public getFirst () inherited from Phalcon\Mvc\Model\Resultset Get first row in the resultset public getLast () inherited from Phalcon\Mvc\Model\Resultset Get last row in the resultset public setIsFresh (mixed $isFresh) inherited from Phalcon\Mvc\Model\Resultset Set if the resultset is fresh or an old one cached public isFresh () inherited from Phalcon\Mvc\Model\Resultset Tell if the resultset if fresh or an old one cached public setHydrateMode (mixed $hydrateMode) inherited from Phalcon\Mvc\Model\Resultset Sets the hydration mode in the resultset public getHydrateMode () inherited from Phalcon\Mvc\Model\Resultset Returns the current hydration mode public getCache () inherited from Phalcon\Mvc\Model\Resultset Returns the associated cache for the resultset public getMessages () inherited from Phalcon\Mvc\Model\Resultset
Returns the error messages produced by a batch operation public boolean update (array $data, [Closure $conditionCallback]) inherited from Phalcon\Mvc\Model\Resultset Updates every record in the resultset public delete ([Closure $conditionCallback]) inherited from Phalcon\Mvc\Model\Resultset Deletes every record in the resultset public Phalcon\Mvc\Model[] filter (callback $filter) inherited from Phalcon\Mvc\Model\Resultset Filters a resultset returning only those the developer requires
$filtered= $robots->filter( function ($robot){ if ($robot->id<3){ return $robot; } } ); public array jsonSerialize () inherited from Phalcon\Mvc\Model\Resultset Returns serialised model objects as array for json_encode. Calls jsonSerialize on each object if present
Class Phalcon\Mvc\Model\Resultset\Simple extends abstract class Phalcon\Mvc\Model\Resultset implements JsonSerializable, Serializable, ArrayAccess, Countable, SeekableIterator, Traversable, Iterator, Phal- con\Mvc\Model\ResultsetInterface Simple resultsets only contains a complete objects This class builds every complete object as it is required
2.5. API 911 Phalcon PHP Framework Documentation, Release 3.1.1
Phalcon\Mvc\Model\Resultset\Simple constructor final public current () Returns current row in the resultset public toArray ([mixed $renameColumns]) Returns a complete resultset as an array, if the resultset has a big number of rows it could consume more memory than currently it does. Export the resultset to an array couldn’t be faster with a large number of records public serialize () Serializing a resultset will dump all related rows into a big array public unserialize (mixed $data) Unserializing a resultset will allow to only works on the rows present in the saved state public next () inherited from Phalcon\Mvc\Model\Resultset Moves cursor to next row in the resultset public valid () inherited from Phalcon\Mvc\Model\Resultset Check whether internal resource has rows to fetch public key () inherited from Phalcon\Mvc\Model\Resultset Gets pointer number of active row in the resultset final public rewind () inherited from Phalcon\Mvc\Model\Resultset Rewinds resultset to its beginning final public seek (mixed $position) inherited from Phalcon\Mvc\Model\Resultset Changes internal pointer to a specific position in the resultset Set new position if required and set this->_row final public count () inherited from Phalcon\Mvc\Model\Resultset Counts how many rows are in the resultset public offsetExists (mixed $index) inherited from Phalcon\Mvc\Model\Resultset Checks whether offset exists in the resultset public offsetGet (mixed $index) inherited from Phalcon\Mvc\Model\Resultset Gets row in a specific position of the resultset public offsetSet (int $index, Phalcon\Mvc\ModelInterface $value) inherited from Phalcon\Mvc\Model\Resultset Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public offsetUnset (mixed $offset) inherited from Phalcon\Mvc\Model\Resultset Resultsets cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public getType () inherited from Phalcon\Mvc\Model\Resultset Returns the internal type of data retrieval that the resultset is using public getFirst () inherited from Phalcon\Mvc\Model\Resultset Get first row in the resultset public getLast () inherited from Phalcon\Mvc\Model\Resultset Get last row in the resultset
912 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public setIsFresh (mixed $isFresh) inherited from Phalcon\Mvc\Model\Resultset Set if the resultset is fresh or an old one cached public isFresh () inherited from Phalcon\Mvc\Model\Resultset Tell if the resultset if fresh or an old one cached public setHydrateMode (mixed $hydrateMode) inherited from Phalcon\Mvc\Model\Resultset Sets the hydration mode in the resultset public getHydrateMode () inherited from Phalcon\Mvc\Model\Resultset Returns the current hydration mode public getCache () inherited from Phalcon\Mvc\Model\Resultset Returns the associated cache for the resultset public getMessages () inherited from Phalcon\Mvc\Model\Resultset Returns the error messages produced by a batch operation public boolean update (array $data, [Closure $conditionCallback]) inherited from Phalcon\Mvc\Model\Resultset Updates every record in the resultset public delete ([Closure $conditionCallback]) inherited from Phalcon\Mvc\Model\Resultset Deletes every record in the resultset public Phalcon\Mvc\Model[] filter (callback $filter) inherited from Phalcon\Mvc\Model\Resultset Filters a resultset returning only those the developer requires
$filtered= $robots->filter( function ($robot){ if ($robot->id<3){ return $robot; } } ); public array jsonSerialize () inherited from Phalcon\Mvc\Model\Resultset Returns serialised model objects as array for json_encode. Calls jsonSerialize on each object if present
Class Phalcon\Mvc\Model\Row implements Phalcon\Mvc\EntityInterface, Phalcon\Mvc\Model\ResultInterface, ArrayAccess, JsonSerializable This component allows Phalcon\Mvc\Model to return rows without an associated entity. This objects implements the ArrayAccess interface to allow access the object as object->x or array[x].
2.5. API 913 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public setDirtyState (mixed $dirtyState) Set the current object’s state public boolean offsetExists (string | int $index) Checks whether offset exists in the row public string | Phalcon\Mvc\ModelInterface offsetGet (string | int $index) Gets a record in a specific position of the row public offsetSet (string | int $index, Phalcon\Mvc\ModelInterface $value) Rows cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public offsetUnset (string | int $offset) Rows cannot be changed. It has only been implemented to meet the definition of the ArrayAccess interface public mixed readAttribute (string $attribute) Reads an attribute value by its name
echo $robot->readAttribute("name");
public writeAttribute (string $attribute, mixed $value) Writes an attribute value by its name
$robot->writeAttribute("name","Rosey");
public array toArray () Returns the instance as an array representation public array jsonSerialize () Serializes the object for json_encode
Class Phalcon\Mvc\Model\Transaction
implements Phalcon\Mvc\Model\TransactionInterface Transactions are protective blocks where SQL statements are only permanent if they can all succeed as one atomic action. Phalcon\Transaction is intended to be used with Phalcon_Model_Base. Phalcon Transactions should be created using Phalcon\Transaction\Manager.
try { $manager= new \Phalcon\Mvc\Model\Transaction\Manager();
public __construct (Phalcon\DiInterface $dependencyInjector, [boolean $autoBegin], [string $service]) Phalcon\Mvc\Model\Transaction constructor public setTransactionManager (Phalcon\Mvc\Model\Transaction\ManagerInterface $manager) Sets transaction manager related to the transaction public begin () Starts the transaction public commit () Commits the transaction public boolean rollback ([string $rollbackMessage], [Phalcon\Mvc\ModelInterface $rollbackRecord]) Rollbacks the transaction public getConnection () Returns the connection related to transaction public setIsNewTransaction (mixed $isNew) Sets if is a reused transaction or new once public setRollbackOnAbort (mixed $rollbackOnAbort) Sets flag to rollback on abort the HTTP connection public isManaged () Checks whether transaction is managed by a transaction manager
2.5. API 915 Phalcon PHP Framework Documentation, Release 3.1.1 public getMessages () Returns validations messages from last save try public isValid () Checks whether internal connection is under an active transaction public setRollbackedRecord (Phalcon\Mvc\ModelInterface $record) Sets object which generates rollback action
Class Phalcon\Mvc\Model\Transaction\Exception extends class Phalcon\Mvc\Model\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\Model\Transaction\Failed extends class Phalcon\Mvc\Model\Transaction\Exception implements Throwable This class will be thrown to exit a try/catch block for isolated transactions
Methods public __construct (mixed $message, [Phalcon\Mvc\ModelInterface $record]) Phalcon\Mvc\Model\Transaction\Failed constructor public getRecordMessages () Returns validation record messages which stop the transaction public getRecord () Returns validation record messages which stop the transaction final private Exception __clone () inherited from Exception Clone the exception public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 917 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Mvc\Model\Transaction\Manager
implements Phalcon\Mvc\Model\Transaction\ManagerInterface, Phalcon\Di\InjectionAwareInterface A transaction acts on a single database connection. If you have multiple class-specific databases, the transaction will not protect interaction among them. This class manages the objects that compose a transaction. A transaction produces a unique connection that is passed to every object part of the transaction.
try { use Phalcon\Mvc\Model\Transaction\Manager as TransactionManager;
public __construct ([Phalcon\DiInterface $dependencyInjector]) Phalcon\Mvc\Model\Transaction\Manager constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injection container public getDI () Returns the dependency injection container
public setDbService (mixed $service) Sets the database service used to run the isolated transactions public string getDbService () Returns the database service used to isolate the transaction public setRollbackPendent (mixed $rollbackPendent) Set if the transaction manager must register a shutdown function to clean up pendent transactions public getRollbackPendent () Check if the transaction manager is registering a shutdown function to clean up pendent transactions public has () Checks whether the manager has an active transaction public get ([mixed $autoBegin]) Returns a new \Phalcon\Mvc\Model\Transaction or an already created once This method registers a shutdown function to rollback active connections public getOrCreateTransaction ([mixed $autoBegin]) Create/Returns a new transaction or an existing one public rollbackPendent () Rollbacks active transactions within the manager public commit () Commits active transactions within the manager public rollback ([boolean $collect]) Rollbacks active transactions within the manager Collect will remove the transaction from the manager public notifyRollback (Phalcon\Mvc\Model\TransactionInterface $transaction) Notifies the manager about a rollbacked transaction public notifyCommit (Phalcon\Mvc\Model\TransactionInterface $transaction) Notifies the manager about a committed transaction protected _collectTransaction (Phalcon\Mvc\Model\TransactionInterface $transaction) Removes transactions from the TransactionManager public collectTransactions () Remove all the transactions from the manager
Class Phalcon\Mvc\Model\ValidationFailed
extends class Phalcon\Mvc\Model\Exception implements Throwable This exception is generated when a model fails to save a record Phalcon\Mvc\Model must be set up to have this behavior
2.5. API 919 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public __construct (Model $model, Message[] $validationMessages) Phalcon\Mvc\Model\ValidationFailed constructor public getModel () Returns the model that generated the messages public getMessages () Returns the complete group of messages produced in the validation final private Exception __clone () inherited from Exception Clone the exception public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface This is a base class for Phalcon\Mvc\Model validators This class is only for backward compatibility reasons to use with Phalcon\Mvc\Collection. Otherwise please use the validators provided by Phalcon\Validation.
public __construct (array $options) Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) Appends a message to the validator public getMessages () Returns messages generated by the validator public array getOptions () Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) Returns an option public isSetOption (mixed $option) Check whether an option has been defined in the validator options abstract public validate (Phalcon\Mvc\EntityInterface $record) inherited from Phalcon\Mvc\Model\ValidatorInterface ...
Class Phalcon\Mvc\Model\Validator\Email
extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Allows to validate if email fields has correct values This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
use Phalcon\Mvc\Model\Validator\Email as EmailValidator; class Subscriptors extends \Phalcon\Mvc\Collection { public function validation() { $this->validate( new EmailValidator( [ "field" =>"electronic_mail", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
2.5. API 921 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Exclusionin
extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Phalcon\Mvc\Model\Validator\ExclusionIn Check if a value is not included into a list of values This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
use Phalcon\Mvc\Model\Validator\ExclusionIn as ExclusionInValidator; class Subscriptors extends \Phalcon\Mvc\Collection { public function validation() { $this->validate( new ExclusionInValidator( [ "field" =>"status", "domain" =>["A","I"], ] ) );
if ($this->validationHasFailed() === true){ return false;
public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Inclusionin
extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Phalcon\Mvc\Model\Validator\InclusionIn Check if a value is included into a list of values This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
use Phalcon\Mvc\Model\Validator\InclusionIn as InclusionInValidator; class Subscriptors extends \Phalcon\Mvc\Collection { public function validation() { $this->validate( new InclusionInValidator( [ "field" =>"status", "domain" =>["A","I"],
2.5. API 923 Phalcon PHP Framework Documentation, Release 3.1.1
] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Ip extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Phalcon\Mvc\Model\Validator\IP Validates that a value is ipv4 address in valid range This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
{ // Any pubic IP $this->validate( new IP( [ "field" =>"server_ip", "version" =>IP::VERSION_4|IP::VERSION_6, // v6 and v4.
˓→The same if not specified "allowReserved" => false, // False if not specified. Ignored
˓→for v6 "allowPrivate" => false, // False if not specified "message" =>"IP address has to be correct", ] ) );
// Any public v4 address $this->validate( new IP( [ "field" =>"ip_4", "version" =>IP::VERSION_4, "message" =>"IP address has to be correct", ] ) );
// Any v6 address $this->validate( new IP( [ "field" =>"ip6", "version" =>IP::VERSION_6, "allowPrivate" => true, "message" =>"IP address has to be correct", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Constants integer VERSION_4 integer VERSION_6
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator
2.5. API 925 Phalcon PHP Framework Documentation, Release 3.1.1 public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Numericality extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Allows to validate if a field has a valid numeric format This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
validate( new NumericalityValidator( [ "field" =>"price", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Methods public validate (Phalcon\Mvc\EntityInterface $record)
Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\PresenceOf extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Allows to validate if a filed have a value different of null and empty string (“”) This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
validate( new PresenceOf( [ "field" =>"name", "message" =>"The name is required", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
2.5. API 927 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Regex
extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Allows validate if the value of a field matches a regular expression This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
use Phalcon\Mvc\Model\Validator\Regex as RegexValidator; class Subscriptors extends \Phalcon\Mvc\Collection { public function validation() { $this->validate( new RegexValidator( [ "field" =>"created_at", "pattern" =>"/^[0-9]{4}[-\/](0[1-9]|1[12])[-\/](0[1-9]|[12][0-
˓→9]|3[01])/", ] ) );
if ($this->validationHasFailed() == true){ return false; }
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\StringLength extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Simply validates specified string length constraints This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
validate( new StringLengthValidator( [ "field" =>"name_last", "max" => 50, "min" =>2, "messageMaximum" =>"We don't like really long names", "messageMinimum" =>"We want more than just their initials",
2.5. API 929 Phalcon PHP Framework Documentation, Release 3.1.1
] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Uniqueness extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Validates that a field or a combination of a set of fields are not present more than once in the existing records of the related table This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
{ $this->validate( new Uniqueness( [ "field" =>"email", "message" =>"Value of field 'email' is already present in
˓→another record", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Model\Validator\Url extends abstract class Phalcon\Mvc\Model\Validator implements Phalcon\Mvc\Model\ValidatorInterface Allows to validate if a field has a url format This validator is only for use with Phalcon\Mvc\Collection. If you are using Phalcon\Mvc\Model, please use the validators provided by Phalcon\Validation.
2.5. API 931 Phalcon PHP Framework Documentation, Release 3.1.1
validate( new UrlValidator( [ "field" =>"source_url", ] ) );
if ($this->validationHasFailed() === true){ return false; } } }
Methods public validate (Phalcon\Mvc\EntityInterface $record) Executes the validator public __construct (array $options) inherited from Phalcon\Mvc\Model\Validator Phalcon\Mvc\Model\Validator constructor protected appendMessage (string $message, [string | array $field], [string $type]) inherited from Phal- con\Mvc\Model\Validator Appends a message to the validator public getMessages () inherited from Phalcon\Mvc\Model\Validator Returns messages generated by the validator public array getOptions () inherited from Phalcon\Mvc\Model\Validator Returns all the options from the validator public getOption (mixed $option, [mixed $defaultValue]) inherited from Phalcon\Mvc\Model\Validator Returns an option public isSetOption (mixed $option) inherited from Phalcon\Mvc\Model\Validator Check whether an option has been defined in the validator options
Class Phalcon\Mvc\Router implements Phalcon\Di\InjectionAwareInterface, Phalcon\Mvc\RouterInterface, Phal- con\Events\EventsAwareInterface
Phalcon\Mvc\Router is the standard framework router. Routing is the process of taking a URI endpoint (that part of the URI which comes after the base URL) and decomposing it into parameters to determine which module, controller, and action of that controller should receive the request
public __construct ([mixed $defaultRoutes]) Phalcon\Mvc\Router constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) Sets the events manager public getEventsManager () Returns the internal event manager public getRewriteUri () Get rewrite info. This info is read from $_GET[”_url”]. This returns ‘/’ if the rewrite information cannot be read public setUriSource (mixed $uriSource) Sets the URI source. One of the URI_SOURCE_* constants
2.5. API 933 Phalcon PHP Framework Documentation, Release 3.1.1
$router->setUriSource( Router::URI_SOURCE_SERVER_REQUEST_URI ); public removeExtraSlashes (mixed $remove) Set whether router must remove the extra slashes in the handled routes public setDefaultNamespace (mixed $namespaceName) Sets the name of the default namespace public setDefaultModule (mixed $moduleName) Sets the name of the default module public setDefaultController (mixed $controllerName) Sets the default controller name public setDefaultAction (mixed $actionName) Sets the default action name public setDefaults (array $defaults) Sets an array of default paths. If a route is missing a path the router will use the defined here This method must not be used to set a 404 route
$router->setDefaults( [ "module" =>"common", "action" =>"index", ] ); public getDefaults () Returns an array of default parameters public handle ([mixed $uri]) Handles routing information received from the rewrite engine
// Read the info from the rewrite engine $router->handle();
// Manually passing an URL $router->handle("/posts/edit/1"); public add (mixed $pattern, [mixed $paths], [mixed $httpMethods], [mixed $position]) Adds a route to the router without any HTTP constraint
$router->add("/about","About::index"); $router->add("/about","About::index",["GET","POST"]); $router->add("/about","About::index",["GET","POST"], Router::POSITION_FIRST); public addGet (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is GET public addPost (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is POST public addPut (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is PUT public addPatch (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is PATCH public addDelete (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is DELETE public addOptions (mixed $pattern, [mixed $paths], [mixed $position]) Add a route to the router that only match if the HTTP method is OPTIONS public addHead (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is HEAD public addPurge (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is PURGE (Squid and Varnish support) public addTrace (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is TRACE public addConnect (mixed $pattern, [mixed $paths], [mixed $position]) Adds a route to the router that only match if the HTTP method is CONNECT public mount (Phalcon\Mvc\Router\GroupInterface $group) Mounts a group of routes in the router public notFound (mixed $paths) Set a group of paths to be returned when none of the defined routes are matched public clear () Removes all the pre-defined routes public getNamespaceName () Returns the processed namespace name public getModuleName () Returns the processed module name public getControllerName () Returns the processed controller name public getActionName ()
2.5. API 935 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the processed action name public getParams () Returns the processed parameters public getMatchedRoute () Returns the route that matches the handled URI public getMatches () Returns the sub expressions in the regular expression matched public wasMatched () Checks if the router matches any of the defined routes public getRoutes () Returns all the routes defined in the router public getRouteById (mixed $id) Returns a route object by its id public getRouteByName (mixed $name) Returns a route object by its name public isExactControllerName () Returns whether controller name should not be mangled
Class Phalcon\Mvc\Router\Annotations
extends class Phalcon\Mvc\Router implements Phalcon\Events\EventsAwareInterface, Phalcon\Mvc\RouterInterface, Phal- con\Di\InjectionAwareInterface A router that reads routes annotations from classes/resources
use Phalcon\Mvc\Router\Annotations;
$di->setShared( "router", function() { // Use the annotations router $router= new Annotations(false);
// This will do the same as above but only if the handled uri starts with /
Methods public addResource (mixed $handler, [mixed $prefix]) Adds a resource to the annotations handler A resource is a class that contains routing annotations public addModuleResource (mixed $module, mixed $handler, [mixed $prefix]) Adds a resource to the annotations handler A resource is a class that contains routing annotations The class is located in a module public handle ([mixed $uri]) Produce the routing parameters from the rewrite information public processControllerAnnotation (mixed $handler, Phalcon\Annotations\Annotation $annotation) Checks for annotations in the controller docblock public processActionAnnotation (mixed $module, mixed $namespaceName, mixed $controller, mixed $action, Phal- con\Annotations\Annotation $annotation) Checks for annotations in the public methods of the controller public setControllerSuffix (mixed $controllerSuffix) Changes the controller class suffix public setActionSuffix (mixed $actionSuffix) Changes the action method suffix public getResources () Return the registered resources public __construct ([mixed $defaultRoutes]) inherited from Phalcon\Mvc\Router Phalcon\Mvc\Router constructor public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Mvc\Router Sets the dependency injector public getDI () inherited from Phalcon\Mvc\Router Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Mvc\Router Sets the events manager public getEventsManager () inherited from Phalcon\Mvc\Router Returns the internal event manager public getRewriteUri () inherited from Phalcon\Mvc\Router
2.5. API 937 Phalcon PHP Framework Documentation, Release 3.1.1
Get rewrite info. This info is read from $_GET[”_url”]. This returns ‘/’ if the rewrite information cannot be read public setUriSource (mixed $uriSource) inherited from Phalcon\Mvc\Router Sets the URI source. One of the URI_SOURCE_* constants
public removeExtraSlashes (mixed $remove) inherited from Phalcon\Mvc\Router Set whether router must remove the extra slashes in the handled routes public setDefaultNamespace (mixed $namespaceName) inherited from Phalcon\Mvc\Router Sets the name of the default namespace public setDefaultModule (mixed $moduleName) inherited from Phalcon\Mvc\Router Sets the name of the default module public setDefaultController (mixed $controllerName) inherited from Phalcon\Mvc\Router Sets the default controller name public setDefaultAction (mixed $actionName) inherited from Phalcon\Mvc\Router Sets the default action name public setDefaults (array $defaults) inherited from Phalcon\Mvc\Router Sets an array of default paths. If a route is missing a path the router will use the defined here This method must not be used to set a 404 route
public getDefaults () inherited from Phalcon\Mvc\Router Returns an array of default parameters public add (mixed $pattern, [mixed $paths], [mixed $httpMethods], [mixed $position]) inherited from Phal- con\Mvc\Router Adds a route to the router without any HTTP constraint
938 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public addGet (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is GET public addPost (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is POST public addPut (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is PUT public addPatch (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is PATCH public addDelete (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is DELETE public addOptions (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Add a route to the router that only match if the HTTP method is OPTIONS public addHead (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is HEAD public addPurge (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is PURGE (Squid and Varnish support) public addTrace (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is TRACE public addConnect (mixed $pattern, [mixed $paths], [mixed $position]) inherited from Phalcon\Mvc\Router Adds a route to the router that only match if the HTTP method is CONNECT public mount (Phalcon\Mvc\Router\GroupInterface $group) inherited from Phalcon\Mvc\Router Mounts a group of routes in the router public notFound (mixed $paths) inherited from Phalcon\Mvc\Router Set a group of paths to be returned when none of the defined routes are matched public clear () inherited from Phalcon\Mvc\Router Removes all the pre-defined routes public getNamespaceName () inherited from Phalcon\Mvc\Router Returns the processed namespace name public getModuleName () inherited from Phalcon\Mvc\Router Returns the processed module name public getControllerName () inherited from Phalcon\Mvc\Router Returns the processed controller name public getActionName () inherited from Phalcon\Mvc\Router Returns the processed action name public getParams () inherited from Phalcon\Mvc\Router Returns the processed parameters
2.5. API 939 Phalcon PHP Framework Documentation, Release 3.1.1
public getMatchedRoute () inherited from Phalcon\Mvc\Router Returns the route that matches the handled URI public getMatches () inherited from Phalcon\Mvc\Router Returns the sub expressions in the regular expression matched public wasMatched () inherited from Phalcon\Mvc\Router Checks if the router matches any of the defined routes public getRoutes () inherited from Phalcon\Mvc\Router Returns all the routes defined in the router public getRouteById (mixed $id) inherited from Phalcon\Mvc\Router Returns a route object by its id public getRouteByName (mixed $name) inherited from Phalcon\Mvc\Router Returns a route object by its name public isExactControllerName () inherited from Phalcon\Mvc\Router Returns whether controller name should not be mangled
Class Phalcon\Mvc\Router\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace
final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\Router\Group implements Phalcon\Mvc\Router\GroupInterface Helper class to create a group of routes with common attributes
$router= new \Phalcon\Mvc\Router();
//Create a group with a common module and controller $blog= new Group( [ "module" =>"blog", "controller" =>"index", ] );
//All the routes start with /blog $blog->setPrefix("/blog");
//Add a route to the group $blog->add( "/save", [ "action" =>"save", ] );
//Add another route to the group $blog->add( "/edit/{id}", [ "action" =>"edit", ] );
//This route maps to a controller different than the default $blog->add( "/blog", [ "controller" =>"about", "action" =>"index", ] );
//Add the group to the router $router->mount($blog);
2.5. API 941 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public __construct ([mixed $paths]) Phalcon\Mvc\Router\Group constructor public setHostname (mixed $hostname) Set a hostname restriction for all the routes in the group public getHostname () Returns the hostname restriction public setPrefix (mixed $prefix) Set a common uri prefix for all the routes in this group public getPrefix () Returns the common prefix for all the routes public beforeMatch (mixed $beforeMatch) Sets a callback that is called if the route is matched. The developer can implement any arbitrary conditions here If the callback returns false the route is treated as not matched public getBeforeMatch () Returns the ‘before match’ callback if any public setPaths (mixed $paths) Set common paths for all the routes in the group public getPaths () Returns the common paths defined for this group public getRoutes () Returns the routes added to the group public add (mixed $pattern, [mixed $paths], [mixed $httpMethods]) Adds a route to the router on any HTTP method
$router->add("/about","About::index");
public Phalcon\Mvc\Router\Route addGet (string $pattern, [string/array $paths]) Adds a route to the router that only match if the HTTP method is GET public Phalcon\Mvc\Router\Route addPost (string $pattern, [string/array $paths]) Adds a route to the router that only match if the HTTP method is POST public Phalcon\Mvc\Router\Route addPut (string $pattern, [string/array $paths]) Adds a route to the router that only match if the HTTP method is PUT public Phalcon\Mvc\Router\Route addPatch (string $pattern, [string/array $paths])
Adds a route to the router that only match if the HTTP method is PATCH public Phalcon\Mvc\Router\Route addDelete (string $pattern, [string/array $paths]) Adds a route to the router that only match if the HTTP method is DELETE public Phalcon\Mvc\Router\Route addOptions (string $pattern, [string/array $paths]) Add a route to the router that only match if the HTTP method is OPTIONS public Phalcon\Mvc\Router\Route addHead (string $pattern, [string/array $paths]) Adds a route to the router that only match if the HTTP method is HEAD public clear () Removes all the pre-defined routes protected _addRoute (mixed $pattern, [mixed $paths], [mixed $httpMethods]) Adds a route applying the common attributes
Class Phalcon\Mvc\Router\Route
implements Phalcon\Mvc\Router\RouteInterface This class represents every route added to the router
Methods
public __construct (mixed $pattern, [mixed $paths], [mixed $httpMethods]) Phalcon\Mvc\Router\Route constructor public compilePattern (mixed $pattern) Replaces placeholders from pattern returning a valid PCRE regular expression public via (mixed $httpMethods) Set one or more HTTP methods that constraint the matching of the route
$route->via("GET");
$route->via( [ "GET", "POST", ] );
public extractNamedParams (mixed $pattern) Extracts parameters from a string public reConfigure (mixed $pattern, [mixed $paths]) Reconfigure the route adding a new pattern and a set of paths public static getRoutePaths ([mixed $paths]) Returns routePaths
2.5. API 943 Phalcon PHP Framework Documentation, Release 3.1.1
public getName () Returns the route’s name public setName (mixed $name) Sets the route’s name
public beforeMatch (mixed $callback) Sets a callback that is called if the route is matched. The developer can implement any arbitrary conditions here If the callback returns false the route is treated as not matched
$router->add( "/login", [ "module" =>"admin", "controller" =>"session", ] )->beforeMatch( function ($uri, $route){ // Check if the request was made with Ajax if ($_SERVER["HTTP_X_REQUESTED_WITH"] ==="xmlhttprequest"){ return false; }
return true; } );
public getBeforeMatch () Returns the ‘before match’ callback if any public match (mixed $callback) Allows to set a callback to handle the request directly in the route
Returns the ‘match’ callback if any public getRouteId () Returns the route’s id public getPattern () Returns the route’s pattern public getCompiledPattern () Returns the route’s compiled pattern public getPaths () Returns the paths public getReversedPaths () Returns the paths using positions as keys and names as values public setHttpMethods (mixed $httpMethods) Sets a set of HTTP methods that constraint the matching of the route (alias of via)
public getHttpMethods () Returns the HTTP methods that constraint matching the route public setHostname (mixed $hostname) Sets a hostname restriction to the route
$route->setHostname("localhost");
public getHostname () Returns the hostname restriction if any public setGroup (Phalcon\Mvc\Router\GroupInterface $group) Sets the group associated with the route public getGroup () Returns the group associated with the route public convert (mixed $name, mixed $converter) Adds a converter to perform an additional transformation for certain parameter public getConverters () Returns the router converter public static reset () Resets the internal route id generator
2.5. API 945 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Mvc\Url
implements Phalcon\Mvc\UrlInterface, Phalcon\Di\InjectionAwareInterface This components helps in the generation of: URIs, URLs and Paths
// Generate a URL appending the URI to the base URI echo $url->get("products/edit/1");
// Generate a URL for a predefined route echo $url->get( [ "for" =>"blog-post", "title" =>"some-cool-stuff", "year" =>"2012", ] );
Methods
public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public setBaseUri (mixed $baseUri) Sets a prefix for all the URIs to be generated
$url->setBaseUri("/invo/");
$url->setBaseUri("/invo/index.php/");
public setStaticBaseUri (mixed $staticBaseUri) Sets a prefix for all static URLs generated
$url->setStaticBaseUri("/invo/");
public getBaseUri () Returns the prefix for all the generated urls. By default / public getStaticBaseUri () Returns the prefix for all the generated static urls. By default / public setBasePath (mixed $basePath) Sets a base path for all the generated paths
$url->setBasePath("/var/www/htdocs/"); public getBasePath () Returns the base path public get ([mixed $uri], [mixed $args], [mixed $local], [mixed $baseUri]) Generates a URL
// Generate a URL appending the URI to the base URI echo $url->get("products/edit/1");
// Generate a URL for a predefined route echo $url->get( [ "for" =>"blog-post", "title" =>"some-cool-stuff", "year" =>"2015", ] );
// Generate a URL with GET arguments (/show/products?id=1&name=Carrots) echo $url->get( "show/products", [ "id" =>1, "name" =>"Carrots", ] );
// Generate an absolute URL by setting the third parameter as false. echo $url->get( "https://phalconphp.com/", null, false ); public getStatic ([mixed $uri]) Generates a URL for a static resource
// Generate a URL for a static resource echo $url->getStatic("img/logo.png");
// Generate a URL for a static predefined route echo $url->getStatic( [ "for" =>"logo-cdn", ] ); public path ([mixed $path])
2.5. API 947 Phalcon PHP Framework Documentation, Release 3.1.1
Generates a local path
Class Phalcon\Mvc\Url\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\User\Component
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\User\Module
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface
Methods public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\User\Plugin
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface
2.5. API 949 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\View
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\Mvc\ViewInterface, Phalcon\Mvc\ViewBaseInterface Phalcon\Mvc\View is a class for working with the “view” portion of the model-view-controller pattern. That is, it exists to help keep the view script separate from the model and controller scripts. It provides a system of helpers, output filters, and variable escaping.
Methods public getRenderLevel () ... public getCurrentRenderLevel () ... public getRegisteredEngines () public __construct ([array $options]) Phalcon\Mvc\View constructor final protected _isAbsolutePath (mixed $path) Checks if a path is absolute or not public setViewsDir (mixed $viewsDir) Sets the views directory. Depending of your platform, always add a trailing slash or backslash public getViewsDir () Gets views directory public setLayoutsDir (mixed $layoutsDir) Sets the layouts sub-directory. Must be a directory under the views directory. Depending of your platform, always add a trailing slash or backslash
$view->setLayoutsDir("../common/layouts/"); public getLayoutsDir () Gets the current layouts sub-directory public setPartialsDir (mixed $partialsDir) Sets a partials sub-directory. Must be a directory under the views directory. Depending of your platform, always add a trailing slash or backslash
$view->setPartialsDir("../common/partials/"); public getPartialsDir () Gets the current partials sub-directory public setBasePath (mixed $basePath)
2.5. API 951 Phalcon PHP Framework Documentation, Release 3.1.1
Sets base path. Depending of your platform, always add a trailing slash or backslash
$view->setBasePath(__DIR__."/"); public getBasePath () Gets base path public setRenderLevel (mixed $level) Sets the render level for the view
// Render the view related to the controller only $this->view->setRenderLevel( View::LEVEL_LAYOUT ); public disableLevel (mixed $level) Disables a specific level of rendering
// Render all levels except ACTION level $this->view->disableLevel( View::LEVEL_ACTION_VIEW ); public setMainView (mixed $viewPath) Sets default view name. Must be a file without extension in the views directory
// Renders as main view views-dir/base.phtml $this->view->setMainView("base"); public getMainView () Returns the name of the main view public setLayout (mixed $layout) Change the layout to be used instead of using the name of the latest controller name
$this->view->setLayout("main"); public getLayout () Returns the name of the main view public setTemplateBefore (mixed $templateBefore) Sets a template before the controller layout public cleanTemplateBefore ()
Resets any “template before” layouts public setTemplateAfter (mixed $templateAfter) Sets a “template after” controller layout public cleanTemplateAfter () Resets any template before layouts public setParamToView (mixed $key, mixed $value) Adds parameters to views (alias of setVar)
$this->view->setParamToView("products", $products); public setVars (array $params, [mixed $merge]) Set all the render params
$this->view->setVars( [ "products" => $products, ] ); public setVar (mixed $key, mixed $value) Set a single view parameter
$this->view->setVar("products", $products); public getVar (mixed $key) Returns a parameter previously set in the view public getParamsToView () Returns parameters to views public getControllerName () Gets the name of the controller rendered public getActionName () Gets the name of the action rendered public getParams () Gets extra parameters of the action rendered public start () Starts rendering process enabling the output buffering protected _loadTemplateEngines () Loads registered template engines, if none is registered it will use Phalcon\Mvc\View\Engine\Php
2.5. API 953 Phalcon PHP Framework Documentation, Release 3.1.1
protected _engineRender (array $engines, string $viewPath, boolean $silence, boolean $mustClean, [Phal- con\Cache\BackendInterface $cache]) Checks whether view exists on registered extensions and render it public registerEngines (array $engines) Register templating engines
public exists (mixed $view) Checks whether view exists public render (string $controllerName, string $actionName, [array $params]) Executes render process from dispatching data
// Retrieve the contents of a partial with arguments echo $this->getPartial( "shared/footer", [ "content" => $html, ] ); public partial (mixed $partialPath, [mixed $params]) Renders a partial view
// Show a partial inside another view $this->partial("shared/footer");
// Show a partial inside another view with parameters $this->partial( "shared/footer", [ "content" => $html, ] ); public string getRender (string $controllerName, string $actionName, [array $params], [mixed $configCallback]) Perform the automatic rendering returning the output as a string
$template= $this->view->getRender( "products", "show", [ "products" => $products, ] ); public finish () Finishes the render process by stopping the output buffering protected _createCache () Create a Phalcon\Cache based on the internal cache options public isCaching () Check if the component is currently caching the output content public getCache () Returns the cache instance used to cache public cache ([mixed $options]) Cache the actual view render to certain level
2.5. API 955 Phalcon PHP Framework Documentation, Release 3.1.1
$this->view->cache( [ "key" =>"my-key", "lifetime" => 86400, ] ); public setContent (mixed $content) Externally sets the view content
$this->view->setContent("
hello
"); public getContent () Returns cached output from another view stage public getActiveRenderPath () Returns the path (or paths) of the views that are currently rendered public disable () Disables the auto-rendering process public enable () Enables the auto-rendering process public reset () Resets the view component to its factory default values public __set (mixed $key, mixed $value) Magic method to pass variables to the views
$this->view->products= $products; public __get (mixed $key) Magic method to retrieve a variable passed to the view
view->products; public isDisabled () Whether automatic rendering is enabled public __isset (mixed $key) Magic method to retrieve if a variable is set in the view
protected getViewsDirs () Gets views directories public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager
Abstract class Phalcon\Mvc\View\Engine extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Mvc\View\EngineInterface All the template engine adapters must inherit this class. This provides basic interfacing between the engine and the Phalcon\Mvc\View component.
Methods public __construct (Phalcon\Mvc\ViewBaseInterface $view, [Phalcon\DiInterface $dependencyInjector]) Phalcon\Mvc\View\Engine constructor public getContent () Returns cached output on another view stage public string partial (string $partialPath, [array $params]) Renders a partial inside another view public getView () Returns the view component related to the adapter public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable
2.5. API 957 Phalcon PHP Framework Documentation, Release 3.1.1
Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get abstract public render (mixed $path, mixed $params, [mixed $mustClean]) inherited from Phal- con\Mvc\View\EngineInterface ...
Class Phalcon\Mvc\View\Engine\Php extends abstract class Phalcon\Mvc\View\Engine implements Phalcon\Mvc\View\EngineInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Events\EventsAwareInterface Adapter to use PHP itself as templating engine
Methods public render (mixed $path, mixed $params, [mixed $mustClean]) Renders a view using the template engine public __construct (Phalcon\Mvc\ViewBaseInterface $view, [Phalcon\DiInterface $dependencyInjector]) inherited from Phalcon\Mvc\View\Engine Phalcon\Mvc\View\Engine constructor public getContent () inherited from Phalcon\Mvc\View\Engine Returns cached output on another view stage public string partial (string $partialPath, [array $params]) inherited from Phalcon\Mvc\View\Engine Renders a partial inside another view public getView () inherited from Phalcon\Mvc\View\Engine Returns the view component related to the adapter public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
extends abstract class Phalcon\Mvc\View\Engine implements Phalcon\Mvc\View\EngineInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Events\EventsAwareInterface Designer friendly and fast template engine for PHP written in Zephir/C
Methods public setOptions (array $options) Set Volt’s options public getOptions () Return Volt’s options public getCompiler () Returns the Volt’s compiler public render (mixed $templatePath, mixed $params, [mixed $mustClean]) Renders a view using the template engine public length (mixed $item) Length filter. If an array/object is passed a count is performed otherwise a strlen/mb_strlen public isIncluded (mixed $needle, mixed $haystack) Checks if the needle is included in the haystack public convertEncoding (mixed $text, mixed $from, mixed $to) Performs a string conversion public slice (mixed $value, [mixed $start], [mixed $end]) Extracts a slice from a string/array/traversable object value public sort (array $value) Sorts an array public callMacro (mixed $name, [array $arguments]) Checks if a macro is defined and calls it public __construct (Phalcon\Mvc\ViewBaseInterface $view, [Phalcon\DiInterface $dependencyInjector]) inherited from Phalcon\Mvc\View\Engine Phalcon\Mvc\View\Engine constructor public getContent () inherited from Phalcon\Mvc\View\Engine Returns cached output on another view stage public string partial (string $partialPath, [array $params]) inherited from Phalcon\Mvc\View\Engine Renders a partial inside another view public getView () inherited from Phalcon\Mvc\View\Engine Returns the view component related to the adapter
2.5. API 959 Phalcon PHP Framework Documentation, Release 3.1.1
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Class Phalcon\Mvc\View\Engine\Volt\Compiler
implements Phalcon\Di\InjectionAwareInterface This class reads and compiles Volt templates into PHP plain code
$compiler= new \Phalcon\Mvc\View\Engine\Volt\Compiler();
$compiler->compile("views/partials/header.volt");
require $compiler->getCompiledTemplatePath();
Methods
public __construct ([Phalcon\Mvc\ViewBaseInterface $view]) public setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector public getDI () Returns the internal dependency injector public setOptions (array $options) Sets the compiler options public setOption (string $option, mixed $value) Sets a single compiler option public string getOption (string $option) Returns a compiler’s option public getOptions () Returns the compiler options final public mixed fireExtensionEvent (string $name, [array $arguments])
Fires an event to registered extensions public addExtension (mixed $extension) Registers a Volt’s extension public getExtensions () Returns the list of extensions registered in Volt public addFunction (mixed $name, mixed $definition) Register a new function in the compiler public getFunctions () Register the user registered functions public addFilter (mixed $name, mixed $definition) Register a new filter in the compiler public getFilters () Register the user registered filters public setUniquePrefix (mixed $prefix) Set a unique prefix to be used as prefix for compiled variables public getUniquePrefix () Return a unique prefix to be used as prefix for compiled variables and contexts public attributeReader (array $expr) Resolves attribute reading public functionCall (array $expr) Resolves function intermediate code into PHP function calls public resolveTest (array $test, mixed $left) Resolves filter intermediate code into a valid PHP expression final protected resolveFilter (array $filter, mixed $left) Resolves filter intermediate code into PHP function calls final public expression (array $expr) Resolves an expression node in an AST volt tree final protected string | array _statementListOrExtends (array $statements) Compiles a block of statements public compileForeach (array $statement, [mixed $extendsMode]) Compiles a “foreach” intermediate code representation into plain PHP code public compileForElse () Generates a ‘forelse’ PHP code public compileIf (array $statement, [mixed $extendsMode]) Compiles a ‘if’ statement returning PHP code public compileElseIf (array $statement)
2.5. API 961 Phalcon PHP Framework Documentation, Release 3.1.1
Compiles a “elseif” statement returning PHP code public compileCache (array $statement, [mixed $extendsMode]) Compiles a “cache” statement returning PHP code public compileSet (array $statement) Compiles a “set” statement returning PHP code public compileDo (array $statement) Compiles a “do” statement returning PHP code public compileReturn (array $statement) Compiles a “return” statement returning PHP code public compileAutoEscape (array $statement, mixed $extendsMode) Compiles a “autoescape” statement returning PHP code public string compileEcho (array $statement) Compiles a ‘{{‘ ‘}}’ statement returning PHP code public compileInclude (array $statement) Compiles a ‘include’ statement returning PHP code public compileMacro (array $statement, mixed $extendsMode) Compiles macros public string compileCall (array $statement, boolean $extendsMode) Compiles calls to macros final protected _statementList (array $statements, [mixed $extendsMode]) Traverses a statement list compiling each of its nodes protected _compileSource (mixed $viewCode, [mixed $extendsMode]) Compiles a Volt source code returning a PHP plain version public compileString (mixed $viewCode, [mixed $extendsMode]) Compiles a template into a string
compileString('{{ "hello world" }}'); public string | array compileFile (string $path, string $compiledPath, [boolean $extendsMode]) Compiles a template into a file forcing the destination path
$compiler->compile("views/layouts/main.volt","views/layouts/main.volt.php"); public compile (mixed $templatePath, [mixed $extendsMode]) Compiles a template into a file applying the compiler options This method does not return the compiled path if the template was not compiled
public getTemplatePath () Returns the path that is currently being compiled public getCompiledTemplatePath () Returns the path to the last compiled template public array parse (string $viewCode) Parses a Volt template returning its intermediate representation
print_r( $compiler->parse("{{ 3 + 2 }}") );
protected getFinalPath (mixed $path) Gets the final path with VIEW
Class Phalcon\Mvc\View\Engine\Volt\Exception
extends class Phalcon\Mvc\View\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred
2.5. API 963 Phalcon PHP Framework Documentation, Release 3.1.1
final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Mvc\View\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phal- con\Mvc\ViewBaseInterface This component allows to render views without hierarchical levels
// Or with filename with extension echo $view->render( "templates/my-view.volt", [ "parameter" => $here, ] );
Methods
public getRegisteredEngines () public __construct ([array $options]) Phalcon\Mvc\View\Simple constructor public setViewsDir (mixed $viewsDir) Sets views directory. Depending of your platform, always add a trailing slash or backslash public getViewsDir () Gets views directory public registerEngines (array $engines) Register templating engines
2.5. API 965 Phalcon PHP Framework Documentation, Release 3.1.1
protected array _loadTemplateEngines () Loads registered template engines, if none is registered it will use Phalcon\Mvc\View\Engine\Php final protected _internalRender (string $path, array $params) Tries to render the view with every engine registered in the component public render (string $path, [array $params]) Renders a view public partial (mixed $partialPath, [mixed $params]) Renders a partial view
// Show a partial inside another view $this->partial("shared/footer");
// Show a partial inside another view with parameters $this->partial( "shared/footer", [ "content" => $html, ] );
public setCacheOptions (array $options) Sets the cache options public array getCacheOptions () Returns the cache options protected _createCache () Create a Phalcon\Cache based on the internal cache options public getCache () Returns the cache instance used to cache public cache ([mixed $options]) Cache the actual view render to certain level
$this->view->setParamToView("products", $products); public setVars (array $params, [mixed $merge]) Set all the render params
$this->view->setVars( [ "products" => $products, ] ); public setVar (mixed $key, mixed $value) Set a single view parameter
$this->view->setVar("products", $products); public getVar (mixed $key) Returns a parameter previously set in the view public array getParamsToView () Returns parameters to views public setContent (mixed $content) Externally sets the view content
$this->view->setContent("
hello
"); public getContent () Returns cached output from another view stage public string getActiveRenderPath () Returns the path of the view that is currently rendered public __set (mixed $key, mixed $value) Magic method to pass variables to the views
$this->view->products= $products; public __get (mixed $key) Magic method to retrieve a variable passed to the view
view->products;
2.5. API 967 Phalcon PHP Framework Documentation, Release 3.1.1
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager
Abstract class Phalcon\Paginator\Adapter implements Phalcon\Paginator\AdapterInterface
Methods public setCurrentPage (mixed $page) Set the current page number public setLimit (mixed $limitRows) Set current rows limit public getLimit () Get current rows limit abstract public getPaginate () inherited from Phalcon\Paginator\AdapterInterface ...
Class Phalcon\Paginator\Adapter\Model
extends abstract class Phalcon\Paginator\Adapter implements Phalcon\Paginator\AdapterInterface This adapter allows to paginate data using a Phalcon\Mvc\Model resultset as a base.
Methods public __construct (array $config) Phalcon\Paginator\Adapter\Model constructor public getPaginate () Returns a slice of the resultset to show in the pagination public setCurrentPage (mixed $page) inherited from Phalcon\Paginator\Adapter Set the current page number public setLimit (mixed $limitRows) inherited from Phalcon\Paginator\Adapter Set current rows limit public getLimit () inherited from Phalcon\Paginator\Adapter Get current rows limit
Class Phalcon\Paginator\Adapter\NativeArray extends abstract class Phalcon\Paginator\Adapter implements Phalcon\Paginator\AdapterInterface Pagination using a PHP array as source of data
Methods public __construct (array $config) Phalcon\Paginator\Adapter\NativeArray constructor public getPaginate ()
2.5. API 969 Phalcon PHP Framework Documentation, Release 3.1.1
Returns a slice of the resultset to show in the pagination public setCurrentPage (mixed $page) inherited from Phalcon\Paginator\Adapter Set the current page number public setLimit (mixed $limitRows) inherited from Phalcon\Paginator\Adapter Set current rows limit public getLimit () inherited from Phalcon\Paginator\Adapter Get current rows limit
Class Phalcon\Paginator\Adapter\QueryBuilder
extends abstract class Phalcon\Paginator\Adapter implements Phalcon\Paginator\AdapterInterface Pagination using a PHQL query builder as source of data
public __construct (array $config) public getCurrentPage () Get the current page number public setQueryBuilder (Phalcon\Mvc\Model\Query\Builder $builder) Set query builder object public getQueryBuilder () Get query builder object public getPaginate () Returns a slice of the resultset to show in the pagination public setCurrentPage (mixed $page) inherited from Phalcon\Paginator\Adapter Set the current page number
public setLimit (mixed $limitRows) inherited from Phalcon\Paginator\Adapter Set current rows limit public getLimit () inherited from Phalcon\Paginator\Adapter Get current rows limit
Class Phalcon\Paginator\Exception
extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 971 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Queue\Beanstalk
Class to access the beanstalk queue service. Partially implements the protocol version 1.2
Methods public __construct ([array $parameters]) public connect () Makes a connection to the Beanstalkd server public put (mixed $data, [array $options]) Puts a job on the queue using specified tube. public reserve ([mixed $timeout]) Reserves/locks a ready job from the specified tube. public choose (mixed $tube) Change the active tube. By default the tube is “default”. public watch (mixed $tube) The watch command adds the named tube to the watch list for the current connection. public ignore (mixed $tube) It removes the named tube from the watch list for the current connection. public pauseTube (mixed $tube, mixed $delay) Can delay any new job being reserved for a given time. public kick (mixed $bound)
The kick command applies only to the currently used tube. public stats () Gives statistical information about the system as a whole. public statsTube (mixed $tube) Gives statistical information about the specified tube if it exists. public listTubes () Returns a list of all existing tubes. public listTubeUsed () Returns the tube currently being used by the client. public listTubesWatched () Returns a list tubes currently being watched by the client. public peekReady () Inspect the next ready job. public peekBuried () Return the next job in the list of buried jobs. public peekDelayed () Return the next job in the list of buried jobs. public jobPeek (mixed $id) The peek commands let the client inspect a job in the system. final public readStatus () Reads the latest status from the Beanstalkd server final public readYaml () Fetch a YAML payload from the Beanstalkd server public read ([mixed $length]) Reads a packet from the socket. Prior to reading from the socket will check for availability of the connection. protected write (mixed $data) Writes data to the socket. Performs a connection if none is available public disconnect () Closes the connection to the beanstalk server. public quit () Simply closes the connection.
Class Phalcon\Queue\Beanstalk\Exception extends class Phalcon\Exception implements Throwable
2.5. API 973 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Queue\Beanstalk\Job
Represents a job in a beanstalk queue
Methods public getId () public getBody () public __construct (Phalcon\Queue\Beanstalk $queue, mixed $id, mixed $body) public delete () Removes a job from the server entirely public release ([mixed $priority], [mixed $delay])
The release command puts a reserved job back into the ready queue (and marks its state as “ready”) to be run by any client. It is normally used when the job fails because of a transitory error. public bury ([mixed $priority]) The bury command puts a job into the “buried” state. Buried jobs are put into a FIFO linked list and will not be touched by the server again until a client kicks them with the “kick” command. public touch () The touch command allows a worker to request more time to work on a job. This is useful for jobs that potentially take a long time, but you still want the benefits of a TTR pulling a job away from an unresponsive worker. A worker may periodically tell the server that it’s still alive and processing a job (e.g. it may do this on DEADLINE_SOON). The command postpones the auto release of a reserved job until TTR seconds from when the command is issued. public kick () Move the job to the ready queue if it is delayed or buried. public stats () Gives statistical information about the specified job if it exists. public __wakeup () Checks if the job has been modified after unserializing the object
Final class Phalcon\Registry
implements ArrayAccess, Countable, Iterator, Traversable A registry is a container for storing objects and values in the application space. By storing the value in a registry, the same object is always available throughout your application.
$registry= new \Phalcon\Registry();
// Set value $registry->something="something"; // or $registry["something"]="something";
// Get value $value= $registry->something; // or $value= $registry["something"];
// Check if the key exists $exists= isset($registry->something); // or $exists= isset($registry["something"]);
// Unset unset($registry->something); // or unset($registry["something"]);
In addition to ArrayAccess, Phalcon\Registry also implements Countable (count($registry) will return the number of elements in the registry), Serializable and Iterator (you can iterate over the registry using a foreach loop) interfaces. For PHP 5.4 and higher, JsonSerializable interface is implemented.
2.5. API 975 Phalcon PHP Framework Documentation, Release 3.1.1
Phalcon\Registry is very fast (it is typically faster than any userspace implementation of the registry); however, this comes at a price: Phalcon\Registry is a final class and cannot be inherited from. Though Phalcon\Registry exposes methods like __get(), offsetGet(), count() etc, it is not recommended to invoke them manually (these methods exist mainly to match the interfaces the registry implements): $registry->__get(“property”) is several times slower than $registry->property. Internally all the magic methods (and interfaces except JsonSerializable) are implemented using object handlers or similar techniques: this allows to bypass relatively slow method calls.
Methods
final public __construct () Registry constructor final public offsetExists (mixed $offset) Checks if the element is present in the registry final public offsetGet (mixed $offset) Returns an index in the registry final public offsetSet (mixed $offset, mixed $value) Sets an element in the registry final public offsetUnset (mixed $offset) Unsets an element in the registry final public count () Checks how many elements are in the register final public next () Moves cursor to next row in the registry final public key () Gets pointer number of active row in the registry final public rewind () Rewinds the registry cursor to its beginning public valid () Checks if the iterator is valid public current () Obtains the current value in the internal iterator final public __set (mixed $key, mixed $value) Sets an element in the registry final public __get (mixed $key) Returns an index in the registry final public __isset (mixed $key) ...
Class Phalcon\Security implements Phalcon\Di\InjectionAwareInterface This component provides a set of functions to improve the security in Phalcon applications
Methods public setWorkFactor (mixed $workFactor) ... public getWorkFactor () ... public __construct () Phalcon\Security constructor public setDI (Phalcon\DiInterface $dependencyInjector)
2.5. API 977 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the dependency injector public getDI () Returns the internal dependency injector public setRandomBytes (mixed $randomBytes) Sets a number of bytes to be generated by the openssl pseudo random generator public getRandomBytes () Returns a number of bytes to be generated by the openssl pseudo random generator public getRandom () Returns a secure random number generator instance public getSaltBytes ([mixed $numberBytes]) Generate a >22-length pseudo random string to be used as salt for passwords public hash (mixed $password, [mixed $workFactor]) Creates a password hash using bcrypt with a pseudo random salt public checkHash (mixed $password, mixed $passwordHash, [mixed $maxPassLength]) Checks a plain text password and its hash version to check if the password matches public isLegacyHash (mixed $passwordHash) Checks if a password hash is a valid bcrypt’s hash public getTokenKey () Generates a pseudo random token key to be used as input’s name in a CSRF check public getToken () Generates a pseudo random token value to be used as input’s value in a CSRF check public checkToken ([mixed $tokenKey], [mixed $tokenValue], [mixed $destroyIfValid]) Check if the CSRF token sent in the request is the same that the current in session public getSessionToken () Returns the value of the CSRF token in session public destroyToken () Removes the value of the CSRF token and key from session public computeHmac (mixed $data, mixed $key, mixed $algo, [mixed $raw]) Computes a HMAC public setDefaultHash (mixed $defaultHash) Sets the default hash public getDefaultHash () Returns the default hash public hasLibreSsl () Testing for LibreSSL public getSslVersionNumber ()
Getting OpenSSL or LibreSSL version Parse OPENSSL_VERSION_TEXT because OPENSSL_VERSION_NUMBER is no use for LibreSSL.
getSslVersionNumber() >= 20105){ // ... }
Class Phalcon\Security\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 979 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Security\Random
Secure random number generator class. Provides secure random number generator which is suitable for generating session key in HTTP cookies, etc. It supports following secure random number generators: • random_bytes (PHP 7) • libsodium • openssl, libressl • /dev/urandom Phalcon\Security\Random could be mainly useful for: • Key generation (e.g. generation of complicated keys) • Generating random passwords for new user accounts • Encryption systems
This class partially borrows SecureRandom library from Ruby
Methods public bytes ([mixed $len]) Generates a random binary string The Random::bytes method returns a string and accepts as input an int representing the length in bytes to be returned. If $len is not specified, 16 is assumed. It may be larger in future. The result may contain any byte: “x00” - “xFF”.
$random= new \Phalcon\Security\Random();
$bytes= $random->bytes(); var_dump(bin2hex($bytes)); // Possible output: string(32) "00f6c04b144b41fad6a59111c126e1ee" public hex ([mixed $len]) Generates a random hex string If $len is not specified, 16 is assumed. It may be larger in future. The length of the result string is usually greater of $len.
$random= new \Phalcon\Security\Random(); echo $random->hex(10); // a29f470508d5ccb8e289 public base58 ([mixed $n]) Generates a random base58 string If $len is not specified, 16 is assumed. It may be larger in future. The result may contain alphanumeric characters except 0, O, I and l. It is similar to Base64 but has been modified to avoid both non-alphanumeric characters and letters which might look ambiguous when printed.
$random= new \Phalcon\Security\Random(); echo $random->base58(); // 4kUgL2pdQMSCQtjE public base64 ([mixed $len]) Generates a random base64 string If $len is not specified, 16 is assumed. It may be larger in future. The length of the result string is usually greater of $len. Size formula: 4 *( $len / 3) and this need to be rounded up to a multiple of 4.
$random= new \Phalcon\Security\Random(); echo $random->base64(12); // 3rcq39QzGK9fUqh8
2.5. API 981 Phalcon PHP Framework Documentation, Release 3.1.1 public base64Safe ([mixed $len], [mixed $padding]) Generates a random URL-safe base64 string If $len is not specified, 16 is assumed. It may be larger in future. The length of the result string is usually greater of $len. By default, padding is not generated because “=” may be used as a URL delimiter. The result may contain A-Z, a-z, 0-9, “-” and “_”. “=” is also used if $padding is true. See RFC 3548 for the definition of URL-safe base64.
$random= new \Phalcon\Security\Random(); echo $random->base64Safe(); // GD8JojhzSTrqX7Q8J6uug public uuid () Generates a v4 random UUID (Universally Unique IDentifier) The version 4 UUID is purely random (except the version). It doesn’t contain meaningful information such as MAC address, time, etc. See RFC 4122 for details of UUID. This algorithm sets the version number (4 bits) as well as two reserved bits. All other bits (the remaining 122 bits) are set using a random or pseudorandom data source. Version 4 UUIDs have the form xxxxxxxx-xxxx-4xxx- yxxx-xxxxxxxxxxxx where x is any hexadecimal digit and y is one of 8, 9, A, or B (e.g., f47ac10b-58cc-4372-a567- 0e02b2c3d479).
$random= new \Phalcon\Security\Random(); echo $random->uuid(); // 1378c906-64bb-4f81-a8d6-4ae1bfcdec22 public number (mixed $len) Generates a random number between 0 and $len Returns an integer: 0 <= result <= $len.
$random= new \Phalcon\Security\Random(); echo $random->number(16); // 8
Abstract class Phalcon\Session\Adapter implements Phalcon\Session\AdapterInterface Base class for Phalcon\Session adapters
Phalcon\Session\Adapter constructor public start () Starts the session (if headers are already sent the session will not be started) public setOptions (array $options) Sets session’s options
$session->setOptions( [ "uniqueId" =>"my-private-app", ] ); public getOptions () Get internal options public setName (mixed $name) Set session name public getName () Get session name public regenerateId ([mixed $deleteOldSession]) public get (mixed $index, [mixed $defaultValue], [mixed $remove]) Gets a session variable from an application context
$session->get("auth","yes"); public set (mixed $index, mixed $value) Sets a session variable in an application context
$session->set("auth","yes"); public has (mixed $index) Check whether a session variable is set in an application context
has("auth") ); public remove (mixed $index) Removes a session variable from an application context
2.5. API 983 Phalcon PHP Framework Documentation, Release 3.1.1
$session->remove("auth"); public getId () Returns active session id
getId(); public setId (mixed $id) Set the current session id
$session->setId($id); public isStarted () Check whether the session has been started
isStarted() ); public destroy ([mixed $removeData]) Destroys the active session
destroy() ); var_dump( $session->destroy(true) ); public status () Returns the status of the current session.
status() ); if ($session->status() !== $session::SESSION_ACTIVE){ $session->start(); } public __get (mixed $index)
Alias: Gets a session variable from an application context public __set (mixed $index, mixed $value) Alias: Sets a session variable in an application context public __isset (mixed $index) Alias: Check whether a session variable is set in an application context public __unset (mixed $index) Alias: Removes a session variable from an application context public __destruct () ...
Class Phalcon\Session\Adapter\Files extends abstract class Phalcon\Session\Adapter implements Phalcon\Session\AdapterInterface
Methods public __construct ([array $options]) inherited from Phalcon\Session\Adapter Phalcon\Session\Adapter constructor public start () inherited from Phalcon\Session\Adapter Starts the session (if headers are already sent the session will not be started) public setOptions (array $options) inherited from Phalcon\Session\Adapter Sets session’s options
$session->setOptions( [ "uniqueId" =>"my-private-app", ] ); public getOptions () inherited from Phalcon\Session\Adapter Get internal options public setName (mixed $name) inherited from Phalcon\Session\Adapter Set session name
2.5. API 985 Phalcon PHP Framework Documentation, Release 3.1.1
public getName () inherited from Phalcon\Session\Adapter Get session name public regenerateId ([mixed $deleteOldSession]) inherited from Phalcon\Session\Adapter public get (mixed $index, [mixed $defaultValue], [mixed $remove]) inherited from Phalcon\Session\Adapter Gets a session variable from an application context
$session->get("auth","yes");
public set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Sets a session variable in an application context
$session->set("auth","yes");
public has (mixed $index) inherited from Phalcon\Session\Adapter Check whether a session variable is set in an application context
var_dump( $session->has("auth") );
public remove (mixed $index) inherited from Phalcon\Session\Adapter Removes a session variable from an application context
$session->remove("auth");
public getId () inherited from Phalcon\Session\Adapter Returns active session id
echo $session->getId();
public setId (mixed $id) inherited from Phalcon\Session\Adapter Set the current session id
$session->setId($id);
public isStarted () inherited from Phalcon\Session\Adapter Check whether the session has been started
isStarted() ); public destroy ([mixed $removeData]) inherited from Phalcon\Session\Adapter Destroys the active session
destroy() ); var_dump( $session->destroy(true) ); public status () inherited from Phalcon\Session\Adapter Returns the status of the current session.
status() ); if ($session->status() !== $session::SESSION_ACTIVE){ $session->start(); } public __get (mixed $index) inherited from Phalcon\Session\Adapter Alias: Gets a session variable from an application context public __set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Alias: Sets a session variable in an application context public __isset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Check whether a session variable is set in an application context public __unset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Removes a session variable from an application context public __destruct () inherited from Phalcon\Session\Adapter ...
Class Phalcon\Session\Adapter\Libmemcached extends abstract class Phalcon\Session\Adapter implements Phalcon\Session\AdapterInterface This adapter store sessions in libmemcached
2.5. API 987 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public getLibmemcached () ... public getLifetime () ... public __construct (array $options) Phalcon\Session\Adapter\Libmemcached constructor public open () ... public close () ... public read (mixed $sessionId)
988 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public write (mixed $sessionId, mixed $data) public destroy ([mixed $sessionId]) public gc () public start () inherited from Phalcon\Session\Adapter Starts the session (if headers are already sent the session will not be started) public setOptions (array $options) inherited from Phalcon\Session\Adapter Sets session’s options
$session->setOptions( [ "uniqueId" =>"my-private-app", ] ); public getOptions () inherited from Phalcon\Session\Adapter Get internal options public setName (mixed $name) inherited from Phalcon\Session\Adapter Set session name public getName () inherited from Phalcon\Session\Adapter Get session name public regenerateId ([mixed $deleteOldSession]) inherited from Phalcon\Session\Adapter public get (mixed $index, [mixed $defaultValue], [mixed $remove]) inherited from Phalcon\Session\Adapter Gets a session variable from an application context
$session->get("auth","yes"); public set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Sets a session variable in an application context
$session->set("auth","yes"); public has (mixed $index) inherited from Phalcon\Session\Adapter Check whether a session variable is set in an application context
has("auth") ); public remove (mixed $index) inherited from Phalcon\Session\Adapter Removes a session variable from an application context
2.5. API 989 Phalcon PHP Framework Documentation, Release 3.1.1
$session->remove("auth");
public getId () inherited from Phalcon\Session\Adapter Returns active session id
echo $session->getId();
public setId (mixed $id) inherited from Phalcon\Session\Adapter Set the current session id
$session->setId($id);
public isStarted () inherited from Phalcon\Session\Adapter Check whether the session has been started
var_dump( $session->isStarted() );
public status () inherited from Phalcon\Session\Adapter Returns the status of the current session.
var_dump( $session->status() );
if ($session->status() !== $session::SESSION_ACTIVE){ $session->start(); }
public __get (mixed $index) inherited from Phalcon\Session\Adapter Alias: Gets a session variable from an application context public __set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Alias: Sets a session variable in an application context public __isset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Check whether a session variable is set in an application context public __unset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Removes a session variable from an application context public __destruct () inherited from Phalcon\Session\Adapter ...
Class Phalcon\Session\Adapter\Memcache extends abstract class Phalcon\Session\Adapter implements Phalcon\Session\AdapterInterface This adapter store sessions in memcache
Methods public getMemcache () ... public getLifetime () ... public __construct ([array $options]) Phalcon\Session\Adapter\Memcache constructor public open () ... public close () ... public read (mixed $sessionId)
2.5. API 991 Phalcon PHP Framework Documentation, Release 3.1.1 public write (mixed $sessionId, mixed $data) public destroy ([mixed $sessionId]) public gc () public start () inherited from Phalcon\Session\Adapter Starts the session (if headers are already sent the session will not be started) public setOptions (array $options) inherited from Phalcon\Session\Adapter Sets session’s options
$session->setOptions( [ "uniqueId" =>"my-private-app", ] ); public getOptions () inherited from Phalcon\Session\Adapter Get internal options public setName (mixed $name) inherited from Phalcon\Session\Adapter Set session name public getName () inherited from Phalcon\Session\Adapter Get session name public regenerateId ([mixed $deleteOldSession]) inherited from Phalcon\Session\Adapter public get (mixed $index, [mixed $defaultValue], [mixed $remove]) inherited from Phalcon\Session\Adapter Gets a session variable from an application context
$session->get("auth","yes"); public set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Sets a session variable in an application context
$session->set("auth","yes"); public has (mixed $index) inherited from Phalcon\Session\Adapter Check whether a session variable is set in an application context
has("auth") ); public remove (mixed $index) inherited from Phalcon\Session\Adapter Removes a session variable from an application context
public getId () inherited from Phalcon\Session\Adapter Returns active session id
echo $session->getId();
public setId (mixed $id) inherited from Phalcon\Session\Adapter Set the current session id
$session->setId($id);
public isStarted () inherited from Phalcon\Session\Adapter Check whether the session has been started
var_dump( $session->isStarted() );
public status () inherited from Phalcon\Session\Adapter Returns the status of the current session.
var_dump( $session->status() );
if ($session->status() !== $session::SESSION_ACTIVE){ $session->start(); }
public __get (mixed $index) inherited from Phalcon\Session\Adapter Alias: Gets a session variable from an application context public __set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Alias: Sets a session variable in an application context public __isset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Check whether a session variable is set in an application context public __unset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Removes a session variable from an application context public __destruct () inherited from Phalcon\Session\Adapter ...
2.5. API 993 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Session\Adapter\Redis extends abstract class Phalcon\Session\Adapter implements Phalcon\Session\AdapterInterface This adapter store sessions in Redis
Methods public getRedis () ... public getLifetime () ... public __construct ([array $options]) Phalcon\Session\Adapter\Redis constructor public open () public close () public read (mixed $sessionId) public write (mixed $sessionId, mixed $data)
994 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public destroy ([mixed $sessionId]) public gc () public start () inherited from Phalcon\Session\Adapter Starts the session (if headers are already sent the session will not be started) public setOptions (array $options) inherited from Phalcon\Session\Adapter Sets session’s options
$session->setOptions( [ "uniqueId" =>"my-private-app", ] ); public getOptions () inherited from Phalcon\Session\Adapter Get internal options public setName (mixed $name) inherited from Phalcon\Session\Adapter Set session name public getName () inherited from Phalcon\Session\Adapter Get session name public regenerateId ([mixed $deleteOldSession]) inherited from Phalcon\Session\Adapter public get (mixed $index, [mixed $defaultValue], [mixed $remove]) inherited from Phalcon\Session\Adapter Gets a session variable from an application context
$session->get("auth","yes"); public set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Sets a session variable in an application context
$session->set("auth","yes"); public has (mixed $index) inherited from Phalcon\Session\Adapter Check whether a session variable is set in an application context
has("auth") ); public remove (mixed $index) inherited from Phalcon\Session\Adapter Removes a session variable from an application context
2.5. API 995 Phalcon PHP Framework Documentation, Release 3.1.1
$session->remove("auth");
public getId () inherited from Phalcon\Session\Adapter Returns active session id
echo $session->getId();
public setId (mixed $id) inherited from Phalcon\Session\Adapter Set the current session id
$session->setId($id);
public isStarted () inherited from Phalcon\Session\Adapter Check whether the session has been started
var_dump( $session->isStarted() );
public status () inherited from Phalcon\Session\Adapter Returns the status of the current session.
var_dump( $session->status() );
if ($session->status() !== $session::SESSION_ACTIVE){ $session->start(); }
public __get (mixed $index) inherited from Phalcon\Session\Adapter Alias: Gets a session variable from an application context public __set (mixed $index, mixed $value) inherited from Phalcon\Session\Adapter Alias: Sets a session variable in an application context public __isset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Check whether a session variable is set in an application context public __unset (mixed $index) inherited from Phalcon\Session\Adapter Alias: Removes a session variable from an application context public __destruct () inherited from Phalcon\Session\Adapter ...
implements Phalcon\Di\InjectionAwareInterface, Phalcon\Session\BagInterface, IteratorAggregate, Traversable, Ar- rayAccess, Countable This component helps to separate session data into “namespaces”. Working by this way you can easily create groups of session variables into the application
$user= new \Phalcon\Session\Bag("user");
$user->name="Kimbra Johnson"; $user->age= 22;
Methods
public __construct (mixed $name) Phalcon\Session\Bag constructor public setDI (Phalcon\DiInterface $dependencyInjector) Sets the DependencyInjector container public getDI () Returns the DependencyInjector container public initialize () Initializes the session bag. This method must not be called directly, the class calls it when its internal data is accessed public destroy () Destroys the session bag
$user->destroy();
public set (mixed $property, mixed $value) Sets a value in the session bag
$user->set("name","Kimbra");
public __set (mixed $property, mixed $value) Magic setter to assign values to the session bag
$user->name="Kimbra";
public get (mixed $property, [mixed $defaultValue]) Obtains a value from the session bag optionally setting a default value
2.5. API 997 Phalcon PHP Framework Documentation, Release 3.1.1
get("name","Kimbra"); public __get (mixed $property) Magic getter to obtain values from the session bag
name; public has (mixed $property) Check whether a property is defined in the internal bag
has("name") ); public __isset (mixed $property) Magic isset to check whether a property is defined in the bag
$user->remove("name"); public __unset (mixed $property) Magic unset to remove items using the array syntax
final public count () Return length of bag
count();
final public getIterator () Returns the bag iterator final public offsetSet (mixed $property, mixed $value)
... final public offsetExists (mixed $property) ... final public offsetUnset (mixed $property) ... final public offsetGet (mixed $property) ...
Class Phalcon\Session\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
2.5. API 999 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Tag
Phalcon\Tag is designed to simplify building of HTML tags. It provides a set of helpers to generate HTML in a dynamic way. This component is an abstract class that you can extend to add more helpers.
Methods public static EscaperInterface getEscaper (array $params) Obtains the ‘escaper’ service if required public static renderAttributes (mixed $code, array $attributes) Renders parameters keeping order in their HTML attributes public static setDI (Phalcon\DiInterface $dependencyInjector) Sets the dependency injector container. public static getDI () Internally gets the request dispatcher public static getUrlService () Returns a URL service from the default DI public static getEscaperService () Returns an Escaper service from the default DI public static setAutoescape (mixed $autoescape) Set autoescape mode in generated html public static setDefault (string $id, string $value) Assigns default values to generated tags by helpers
// Assigning "peter" to "name" component Phalcon\Tag::setDefault("name","peter");
// Later in the view echo Phalcon\Tag::textField("name"); // Will have the value "peter" by default public static setDefaults (array $values, [mixed $merge]) Assigns default values to generated tags by helpers
// Later in the view echo Phalcon\Tag::textField("name"); // Will have the value "peter" by default public static displayTo (string $id, string $value) Alias of Phalcon\Tag::setDefault public static boolean hasValue (string $name) Check if a helper has a default value set using Phalcon\Tag::setDefault or value from $_POST public static mixed getValue (string $name, [array $params]) Every helper calls this function to check whether a component has a predefined value using Phalcon\Tag::setDefault or value from $_POST public static resetInput () Resets the request and internal values to avoid those fields will have any default value. public static linkTo (array | string $parameters, [string $text], [boolean $local]) Builds a HTML A tag using framework conventions
"btn-primary",
2.5. API 1001 Phalcon PHP Framework Documentation, Release 3.1.1
echo Phalcon\Tag::numericField( [ "price", "min" =>"1", "max" =>"5", ] ); public static string rangeField (array $parameters) Builds a HTML input[type=”range”] tag public static string emailField (array $parameters) Builds a HTML input[type=”email”] tag
"14-12-1980", ] ); public static string dateTimeField (array $parameters) Builds a HTML input[type=”datetime”] tag public static string dateTimeLocalField (array $parameters) Builds a HTML input[type=”datetime-local”] tag public static string monthField (array $parameters) Builds a HTML input[type=”month”] tag public static string timeField (array $parameters) Builds a HTML input[type=”time”] tag public static string weekField (array $parameters) Builds a HTML input[type=”week”] tag public static string passwordField (array $parameters) Builds a HTML input[type=”password”] tag
30,
2.5. API 1003 Phalcon PHP Framework Documentation, Release 3.1.1
] ); public static string hiddenField (array $parameters) Builds a HTML input[type=”hidden”] tag
"mike", ] ); public static string fileField (array $parameters) Builds a HTML input[type=”file”] tag
"Y", ] );
Volt syntax:
{{ check_field("terms") }} public static string radioField (array $parameters) Builds a HTML input[type=”radio”] tag
{{ radio_field("Save") }} public static string imageInput (array $parameters) Builds a HTML input[type=”image”] tag
"/img/button.png", ] );
Volt syntax:
{{ image_input("src":"/img/button.png") }} public static string submitButton (array $parameters) Builds a HTML input[type=”submit”] tag
Volt syntax:
{{ submit_button("Save") }} public static string selectStatic (array $parameters, [array $data]) Builds a HTML SELECT tag using a PHP array for options
"Active", "I" =>"Inactive", ] );
2.5. API 1005 Phalcon PHP Framework Documentation, Release 3.1.1 public static string select (array $parameters, [array $data]) Builds a HTML SELECT tag using a Phalcon\Mvc\Model resultset as options
["id","name"], ] );
Volt syntax:
{{ select("robotId", robots,"using":["id","name"]) }} public static string textArea (array $parameters) Builds a HTML TEXTAREA tag
10, "rows" =>4, ] );
Volt syntax:
{{ text_area("comments","cols": 10,"rows":4) }} public static string form (array $parameters) Builds a HTML FORM tag
{{ form("posts/save") }} {{ form("posts/save","method":"post") }} public static endForm () Builds a HTML close FORM tag public static setTitle (mixed $title) Set the title of view content
Phalcon\Tag::setTitle("Welcome to my Page"); public static setTitleSeparator (mixed $titleSeparator) Set the title separator of view content
Phalcon\Tag::setTitleSeparator("-"); public static appendTitle (mixed $title) Appends a text to current document title public static prependTitle (mixed $title) Prepends a text to current document title public static getTitle ([mixed $tags]) Gets the current document title. The title will be automatically escaped.
{{ get_title() }} public static getTitleSeparator () Gets the current document title separator
{{ get_title_separator() }} public static string stylesheetLink ([array $parameters], [boolean $local]) Builds a LINK[rel=”stylesheet”] tag
2.5. API 1007 Phalcon PHP Framework Documentation, Release 3.1.1
Class Phalcon\Tag\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception
2.5. API 1009 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Abstract class Phalcon\Tag\Select
Generates a SELECT html tag using a static array of values or a Phalcon\Mvc\Model resultset
Methods
public static selectField (array $parameters, [array $data]) Generates a SELECT tag private static _optionsFromResultset (Phalcon\Mvc\Model\Resultset $resultset, array $using, mixed $value, string $closeOption) Generate the OPTION tags based on a resultset private static _optionsFromArray (array $data, mixed $value, string $closeOption) Generate the OPTION tags based on an array
// "aloiwkqz" echo Phalcon\Text::random( Phalcon\Text::RANDOM_ALNUM ); public static startsWith (mixed $str, mixed $start, [mixed $ignoreCase]) Check if a string starts with a given string
2.5. API 1011 Phalcon PHP Framework Documentation, Release 3.1.1
˓→buz public static concat () Concatenates strings using the separator only once without duplication in places concatenation
// /tmp/folder_1/folder_2/folder_3/ echo $str; public static dynamic (mixed $text, [mixed $leftDelimiter], [mixed $rightDelimiter], [mixed $separator]) Generates random text in accordance with the template
// Hi my name is a Bob echo Phalcon\Text::dynamic("{Hi|Hello}, my name is a{Bob|Mark|Jon}!");
// Hi my name is a Jon echo Phalcon\Text::dynamic("{Hi|Hello}, my name is a{Bob|Mark|Jon}!");
// Hello my name is a Bob echo Phalcon\Text::dynamic("{Hi|Hello}, my name is a{Bob|Mark|Jon}!");
// Hello my name is a Zyxep echo Phalcon\Text::dynamic("[Hi/Hello], my name is a [Zyxep/Mark]!","[","]","/"); public static underscore (mixed $text) Makes a phrase underscored instead of spaced
implements Phalcon\Translate\AdapterInterface Base class for Phalcon\Translate adapters
Methods
public __construct (array $options) ... public setInterpolator (Phalcon\Translate\InterpolatorInterface $interpolator) ... public string t (string $translateKey, [array $placeholders]) Returns the translation string of the given key public string _ (string $translateKey, [array $placeholders]) Returns the translation string of the given key (alias of method ‘t’) public offsetSet (string $offset, string $value) Sets a translation value public offsetExists (mixed $translateKey) Check whether a translation key exists public offsetUnset (string $offset) Unsets a translation from the dictionary public string offsetGet (string $translateKey) Returns the translation related to the given key protected replacePlaceholders (mixed $translation, [mixed $placeholders]) Replaces placeholders by the values passed abstract public query (mixed $index, [mixed $placeholders]) inherited from Phalcon\Translate\AdapterInterface
2.5. API 1013 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public exists (mixed $index) inherited from Phalcon\Translate\AdapterInterface ...
Class Phalcon\Translate\Adapter\Csv extends abstract class Phalcon\Translate\Adapter implements Phalcon\Translate\AdapterInterface, ArrayAccess Allows to define translation lists using CSV file
Methods public __construct (array $options) Phalcon\Translate\Adapter\Csv constructor private _load (string $file, int $length, string $delimiter, string $enclosure) Load translates from file public query (mixed $index, [mixed $placeholders]) Returns the translation related to the given key public exists (mixed $index) Check whether is defined a translation key in the internal array public setInterpolator (Phalcon\Translate\InterpolatorInterface $interpolator) inherited from Phal- con\Translate\Adapter ... public string t (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key public string _ (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key (alias of method ‘t’) public offsetSet (string $offset, string $value) inherited from Phalcon\Translate\Adapter Sets a translation value public offsetExists (mixed $translateKey) inherited from Phalcon\Translate\Adapter Check whether a translation key exists public offsetUnset (string $offset) inherited from Phalcon\Translate\Adapter Unsets a translation from the dictionary public string offsetGet (string $translateKey) inherited from Phalcon\Translate\Adapter Returns the translation related to the given key protected replacePlaceholders (mixed $translation, [mixed $placeholders]) inherited from Phalcon\Translate\Adapter Replaces placeholders by the values passed
Methods public getDirectory () public getDefaultDomain () public getLocale () public getCategory () public __construct (array $options) Phalcon\Translate\Adapter\Gettext constructor public query (mixed $index, [mixed $placeholders]) Returns the translation related to the given key.
$translator->query(" %name%",["name" =>"Phalcon"]); public exists (mixed $index) Check whether is defined a translation key in the internal array public nquery (mixed $msgid1, mixed $msgid2, mixed $count, [mixed $placeholders], [mixed $domain]) The plural version of gettext(). Some languages have more than one form for plural messages dependent on the count. public setDomain (mixed $domain) Changes the current domain (i.e. the translation file) public resetDomain () Sets the default domain public setDefaultDomain (mixed $domain) Sets the domain default to search within when calls are made to gettext() public setDirectory (mixed $directory)
2.5. API 1015 Phalcon PHP Framework Documentation, Release 3.1.1
Sets the path for a domain
// Set the directory path $gettext->setDirectory("/path/to/the/messages");
// Set the domains and directories path $gettext->setDirectory( [ "messages" =>"/path/to/the/messages", "another" =>"/path/to/the/another", ] ); public setLocale (mixed $category, mixed $locale) Sets locale information
// Set locale to Dutch $gettext->setLocale(LC_ALL,"nl_NL");
// Try different possible locale names for german $gettext->setLocale(LC_ALL,"de_DE@euro","de_DE","de","ge"); protected prepareOptions (array $options) Validator for constructor protected getOptionsDefault () Gets default options public setInterpolator (Phalcon\Translate\InterpolatorInterface $interpolator) inherited from Phal- con\Translate\Adapter ... public string t (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key public string _ (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key (alias of method ‘t’) public offsetSet (string $offset, string $value) inherited from Phalcon\Translate\Adapter Sets a translation value public offsetExists (mixed $translateKey) inherited from Phalcon\Translate\Adapter Check whether a translation key exists public offsetUnset (string $offset) inherited from Phalcon\Translate\Adapter Unsets a translation from the dictionary public string offsetGet (string $translateKey) inherited from Phalcon\Translate\Adapter Returns the translation related to the given key protected replacePlaceholders (mixed $translation, [mixed $placeholders]) inherited from Phalcon\Translate\Adapter
Class Phalcon\Translate\Adapter\NativeArray extends abstract class Phalcon\Translate\Adapter implements Phalcon\Translate\AdapterInterface, ArrayAccess Allows to define translation lists using PHP arrays
Methods public __construct (array $options) Phalcon\Translate\Adapter\NativeArray constructor public query (mixed $index, [mixed $placeholders]) Returns the translation related to the given key public exists (mixed $index) Check whether is defined a translation key in the internal array public setInterpolator (Phalcon\Translate\InterpolatorInterface $interpolator) inherited from Phal- con\Translate\Adapter ... public string t (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key public string _ (string $translateKey, [array $placeholders]) inherited from Phalcon\Translate\Adapter Returns the translation string of the given key (alias of method ‘t’) public offsetSet (string $offset, string $value) inherited from Phalcon\Translate\Adapter Sets a translation value public offsetExists (mixed $translateKey) inherited from Phalcon\Translate\Adapter Check whether a translation key exists public offsetUnset (string $offset) inherited from Phalcon\Translate\Adapter Unsets a translation from the dictionary public string offsetGet (string $translateKey) inherited from Phalcon\Translate\Adapter Returns the translation related to the given key protected replacePlaceholders (mixed $translation, [mixed $placeholders]) inherited from Phalcon\Translate\Adapter Replaces placeholders by the values passed
Class Phalcon\Translate\Exception extends class Phalcon\Exception implements Throwable
2.5. API 1017 Phalcon PHP Framework Documentation, Release 3.1.1
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Translate\Interpolator\AssociativeArray implements Phalcon\Translate\InterpolatorInterface
Methods public replacePlaceholders (mixed $translation, [mixed $placeholders]) Replaces placeholders by the values passed
Class Phalcon\Translate\Interpolator\IndexedArray implements Phalcon\Translate\InterpolatorInterface
public replacePlaceholders (mixed $translation, [mixed $placeholders]) Replaces placeholders by the values passed
Class Phalcon\Validation
extends abstract class Phalcon\Di\Injectable implements Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\ValidationInterface Allows to validate data using custom or built-in validators
Methods
public getData () ... public setValidators (mixed $validators) ... public __construct ([array $validators]) Phalcon\Validation constructor public Phalcon\Validation\Message\Group validate ([array | object $data], [object $entity]) Validate a set of data according to a set of rules public add (mixed $field, Phalcon\Validation\ValidatorInterface $validator) Adds a validator to a field public rule (mixed $field, Phalcon\Validation\ValidatorInterface $validator) Alias of add method public rules (mixed $field, array $validators) Adds the validators to a field public Phalcon\Validation setFilters (string $field, array | string $filters) Adds filters to the field public mixed getFilters ([string $field]) Returns all the filters or a specific one public getValidators () Returns the validators added to the validation public setEntity (object $entity) Sets the bound entity public object getEntity () Returns the bound entity public setDefaultMessages ([array $messages])
2.5. API 1019 Phalcon PHP Framework Documentation, Release 3.1.1
Adds default messages to validators public getDefaultMessage (mixed $type) Get default message for validator type public getMessages () Returns the registered validators public setLabels (array $labels) Adds labels for fields public string getLabel (string $field) Get label for field public appendMessage (Phalcon\Validation\MessageInterface $message) Appends a message to the messages list public Phalcon\Validation bind (object $entity, array | object $data) Assigns the data to an entity The entity is used to obtain the validation values public mixed getValue (string $field) Gets the a value to validate in the array/object data source protected preChecking (mixed $field, Phalcon\Validation\ValidatorInterface $validator) Internal validations, if it returns true, then skip the current validator public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable Sets the dependency injector public getDI () inherited from Phalcon\Di\Injectable Returns the internal dependency injector public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phal- con\Di\Injectable Sets the event manager public getEventsManager () inherited from Phalcon\Di\Injectable Returns the internal event manager public __get (mixed $propertyName) inherited from Phalcon\Di\Injectable Magic method __get
Abstract class Phalcon\Validation\CombinedFieldsValidator extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface
Methods public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator abstract public validate (Phalcon\Validation $validation, mixed $attribute) inherited from Phal- con\Validation\Validator Executes the validation
Class Phalcon\Validation\Exception extends class Phalcon\Exception implements Throwable
Methods
final private Exception __clone () inherited from Exception Clone the exception public __construct ([string $message], [int $code], [Exception $previous]) inherited from Exception Exception constructor public __wakeup () inherited from Exception ... final public string getMessage () inherited from Exception Gets the Exception message final public int getCode () inherited from Exception Gets the Exception code final public string getFile () inherited from Exception Gets the file in which the exception occurred final public int getLine () inherited from Exception Gets the line in which the exception occurred final public array getTrace () inherited from Exception
2.5. API 1021 Phalcon PHP Framework Documentation, Release 3.1.1
Gets the stack trace final public Exception getPrevious () inherited from Exception Returns previous Exception final public Exception getTraceAsString () inherited from Exception Gets the stack trace as a string public string __toString () inherited from Exception String representation of the exception
Class Phalcon\Validation\Message implements Phalcon\Validation\MessageInterface Encapsulates validation info generated in the validation process
Methods public __construct (mixed $message, [mixed $field], [mixed $type], [mixed $code]) Phalcon\Validation\Message constructor public setType (mixed $type) Sets message type public getType () Returns message type public setMessage (mixed $message) Sets verbose message public getMessage () Returns verbose message public setField (mixed $field) Sets field name related to message public mixed getField () Returns field name related to message public setCode (mixed $code) Sets code for the message public getCode () Returns the message code public __toString () Magic __toString method returns verbose message public static __set_state (array $message) Magic __set_state helps to recover messages from serialization
implements Countable, ArrayAccess, Iterator, Traversable Represents a group of validation messages
Methods
public __construct ([array $messages]) Phalcon\Validation\Message\Group constructor public Phalcon\Validation\Message offsetGet (int $index) Gets an attribute a message using the array syntax
print_r( $messages[0] );
public offsetSet (int $index, Phalcon\Validation\Message $message) Sets an attribute using the array-syntax
$messages[0]= new \Phalcon\Validation\Message("This is a message");
public boolean offsetExists (int $index) Checks if an index exists
var_dump( isset($message["database"]) );
public offsetUnset (mixed $index) Removes a message from the list
unset($message["database"]);
public appendMessage (Phalcon\Validation\MessageInterface $message) Appends a message to the group
$messages->appendMessage( new \Phalcon\Validation\Message("This is a message") );
2.5. API 1023 Phalcon PHP Framework Documentation, Release 3.1.1
public appendMessages (Phalcon\Validation\MessageInterface[] $messages) Appends an array of messages to the group
$messages->appendMessages($messagesArray);
public array filter (string $fieldName) Filters the message group by field name public count () Returns the number of messages in the list public rewind () Rewinds the internal iterator public current () Returns the current message in the iterator public key () Returns the current position/key in the iterator public next () Moves the internal iteration pointer to the next position public valid () Check if the current message in the iterator is valid public static Phalcon\Validation\Message\Group __set_state (array $group) Magic __set_state helps to re-build messages variable when exporting
Abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface This is a base class for validators
Methods public __construct ([array $options]) Phalcon\Validation\Validator constructor public isSetOption (mixed $key) Checks if an option has been defined public hasOption (mixed $key) Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value)
Sets an option in the validator abstract public validate (Phalcon\Validation $validation, mixed $attribute) Executes the validation
Class Phalcon\Validation\Validator\Alnum extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Check for alphanumeric character(s)
$validator->add( "username", new AlnumValidator( [ "message" =>":field must contain only alphanumeric characters", ] ) );
$validator->add( [ "username", "name", ], new AlnumValidator( [ "message" =>[ "username" =>"username must contain only alphanumeric characters", "name" =>"name must contain only alphanumeric characters", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined
2.5. API 1025 Phalcon PHP Framework Documentation, Release 3.1.1 public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Alpha extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Check for alphabetic character(s)
$validator->add( "username", new AlphaValidator( [ "message" =>":field must contain only letters", ] ) );
$validator->add( [ "username", "name", ], new AlphaValidator( [ "message" =>[ "username" =>"username must contain only letters", "name" =>"name must contain only letters", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator
Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Between extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Validates that a value is between an inclusive range of two values. For a value x, the test is passed if mini- mum<=x<=maximum.
$validator->add( "price", new Between( [ "minimum" =>0, "maximum" => 100, "message" =>"The price must be between 0 and 100", ] ) );
$validator->add( [ "price", "amount", ], new Between( [ "minimum" =>[ "price" =>0, "amount" =>0, ], "maximum" =>[ "price" => 100, "amount" => 50, ], "message" =>[ "price" =>"The price must be between 0 and 100", "amount" =>"The amount must be between 0 and 50", ], ] ) );
2.5. API 1027 Phalcon PHP Framework Documentation, Release 3.1.1
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Confirmation extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks that two values have the same value
$validator->add( "password", new Confirmation( [ "message" =>"Password doesn't match confirmation", "with" =>"confirmPassword", ] ) );
$validator->add( [ "password", "email", ], new Confirmation( [ "message" =>[ "password" =>"Password doesn't match confirmation", "email" =>"Email doesn't match confirmation", ], "with" =>[ "password" =>"confirmPassword", "email" =>"confirmEmail",
public validate (Phalcon\Validation $validation, mixed $field) Executes the validation final protected compare (mixed $a, mixed $b) Compare strings public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\CreditCard
extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks if a value has a valid credit card number
use Phalcon\Validation\Validator\CreditCard as CreditCardValidator;
$validator->add( "creditCard", new CreditCardValidator( [ "message" =>"The credit card number is not valid", ] ) );
2.5. API 1029 Phalcon PHP Framework Documentation, Release 3.1.1
], new CreditCardValidator( [ "message" =>[ "creditCard" =>"The credit card number is not valid", "secondCreditCard" =>"The second credit card number is not valid", ], ] ) );
Methods
public validate (Phalcon\Validation $validation, mixed $field) Executes the validation private boolean verifyByLuhnAlgorithm (string $number) is a simple checksum formula used to validate a variety of identification numbers public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Date
extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks if a value is a valid date
use Phalcon\Validation\Validator\Date as DateValidator;
$validator->add( "date", new DateValidator( [ "format" =>"d-m-Y", "message" =>"The date is invalid", ]
$validator->add( [ "date", "anotherDate", ], new DateValidator( [ "format" =>[ "date" =>"d-m-Y", "anotherDate" =>"Y-m-d", ], "message" =>[ "date" =>"The date is invalid", "anotherDate" =>"The another date is invalid", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation private checkDate (mixed $value, mixed $format) ... public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Digit extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Check for numeric character(s)
2.5. API 1031 Phalcon PHP Framework Documentation, Release 3.1.1
$validator->add( "height", new DigitValidator( [ "message" =>":field must be numeric", ] ) );
$validator->add( [ "height", "width", ], new DigitValidator( [ "message" =>[ "height" =>"height must be numeric", "width" =>"width must be numeric", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Email extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface
$validator->add( "email", new EmailValidator( [ "message" =>"The e-mail is not valid", ] ) );
$validator->add( [ "email", "anotherEmail", ], new EmailValidator( [ "message" =>[ "email" =>"The e-mail is not valid", "anotherEmail" =>"The another e-mail is not valid", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\ExclusionIn extends abstract class Phalcon\Validation\Validator
2.5. API 1033 Phalcon PHP Framework Documentation, Release 3.1.1 implements Phalcon\Validation\ValidatorInterface Check if a value is not included into a list of values
$validator->add( "status", new ExclusionIn( [ "message" => "The status must not be A or B", "domain" => [ "A", "B", ], ] ) );
$validator->add( [ "status", "type", ], new ExclusionIn( [ "message" => [ "status" => "The status must not be A or B", "type" => "The type must not be 1 or "' ], "domain" => [ "status" => [ "A", "B", ], "type" => [1, 2], ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined
1034 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\File extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks if a value has a correct file
$validator->add( "file", new FileValidator( [ "maxSize" =>"2M", "messageSize" =>":field exceeds the max filesize (:max)", "allowedTypes" =>[ "image/jpeg", "image/png", ], "messageType" =>"Allowed file types are :types", "maxResolution" =>"800x600", "messageMaxResolution" =>"Max resolution of :field is :max", ] ) );
$validator->add( [ "file", "anotherFile", ], new FileValidator( [ "maxSize" =>[ "file" =>"2M", "anotherFile" =>"4M", ], "messageSize" =>[ "file" =>"file exceeds the max filesize 2M", "anotherFile" =>"anotherFile exceeds the max filesize 4M", "allowedTypes" =>[ "file" =>[ "image/jpeg", "image/png", ], "anotherFile" =>[ "image/gif", "image/bmp",
2.5. API 1035 Phalcon PHP Framework Documentation, Release 3.1.1
], ], "messageType" =>[ "file" =>"Allowed file types are image/jpeg and image/png", "anotherFile" =>"Allowed file types are image/gif and image/bmp", ], "maxResolution" =>[ "file" =>"800x600", "anotherFile" =>"1024x768", ], "messageMaxResolution" =>[ "file" =>"Max resolution of file is 800x600", "anotherFile" =>"Max resolution of file is 1024x768", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public isAllowEmpty (Phalcon\Validation $validation, mixed $field) Check on empty public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Identical extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks if a value is identical to other
$validator->add( "terms", new Identical( [ "accepted" =>"yes", "message" =>"Terms and conditions must be accepted", ] ) );
$validator->add( [ "terms", "anotherTerms", ], new Identical( [ "accepted" =>[ "terms" =>"yes", "anotherTerms" =>"yes", ], "message" =>[ "terms" =>"Terms and conditions must be accepted", "anotherTerms" =>"Another terms must be accepted", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\InclusionIn extends abstract class Phalcon\Validation\Validator
2.5. API 1037 Phalcon PHP Framework Documentation, Release 3.1.1 implements Phalcon\Validation\ValidatorInterface Check if a value is included into a list of values
$validator->add( "status", new InclusionIn( [ "message" =>"The status must be A or B", "domain" =>["A","B"], ] ) );
$validator->add( [ "status", "type", ], new InclusionIn( [ "message" =>[ "status" =>"The status must be A or B", "type" =>"The status must be 1 or 2", ], "domain" =>[ "status" =>["A","B"], "type" =>[1,2], ] ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator
Class Phalcon\Validation\Validator\Numericality extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Check for a valid numeric value
$validator->add( "price", new Numericality( [ "message" =>":field is not numeric", ] ) );
$validator->add( [ "price", "amount", ], new Numericality( [ "message" =>[ "price" =>"price is not numeric", "amount" =>"amount is not numeric", ] ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set
2.5. API 1039 Phalcon PHP Framework Documentation, Release 3.1.1 public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\PresenceOf extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Validates that a value is not null or empty string
$validator->add( "name", new PresenceOf( [ "message" =>"The name is required", ] ) );
$validator->add( [ "name", "email", ], new PresenceOf( [ "message" =>[ "name" =>"The name is required", "email" =>"The email is required", ], ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator
Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Regex extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Allows validate if the value of a field matches a regular expression
$validator->add( "created_at", new RegexValidator( [ "pattern" =>"/^[0-9]{4}[-\/](0[1-9]|1[12])[-\/](0[1-9]|[12][0-9]|3[01])$/
˓→", "message" =>"The creation date is invalid", ] ) );
˓→9]|3[01])$/", "name" =>"/^[a-z]$/", ], "message" =>[ "created_at" =>"The creation date is invalid", "name" =>"The name is invalid", ] ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor
2.5. API 1041 Phalcon PHP Framework Documentation, Release 3.1.1 public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\StringLength extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Validates that a string has the specified maximum and minimum constraints The test is passed if for a string’s length L, min<=L<=max, i.e. L must be at least min, and at most max.
$validation->add( "name_last", new StringLength( [ "max" => 50, "min" =>2, "messageMaximum" =>"We don't like really long names", "messageMinimum" =>"We want more than just their initials", ] ) );
$validation->add( [ "name_last", "name_first", ], new StringLength( [ "max" =>[ "name_last" => 50, "name_first" => 40, ], "min" =>[ "name_last" =>2, "name_first" =>4, ], "messageMaximum" =>[ "name_last" =>"We don't like really long last names", "name_first" =>"We don't like really long first names", ], "messageMinimum" =>[
"name_last" =>"We don't like too short last names", "name_first" =>"We don't like too short first names", ] ] ) );
Methods
public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Uniqueness
extends abstract class Phalcon\Validation\CombinedFieldsValidator implements Phalcon\Validation\ValidatorInterface Check that a field is unique in the related table
use Phalcon\Validation\Validator\Uniqueness as UniquenessValidator;
$validator->add( "username", new UniquenessValidator( [ "model" => new Users(), "message" =>":field must be unique", ] ) );
Different attribute from the field:
2.5. API 1043 Phalcon PHP Framework Documentation, Release 3.1.1
$validator->add( "username", new UniquenessValidator( [ "model" => new Users(), "attribute" =>"nick", ] ) );
In model:
$validator->add( "username", new UniquenessValidator() );
Combination of fields in model:
$validator->add( [ "firstName", "lastName", ], new UniquenessValidator() );
It is possible to convert values before validation. This is useful in situations where values need to be converted to do the database lookup:
$validator->add( "username", new UniquenessValidator( [ "convert" => function (array $values){ $values["username"]= strtolower($values["username"]);
return $values; } ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation
protected isUniqueness (Phalcon\Validation $validation, mixed $field) ... protected getColumnNameReal (mixed $record, mixed $field) The column map is used in the case to get real column name protected isUniquenessModel (mixed $record, array $field, array $values) Uniqueness method used for model protected isUniquenessCollection (mixed $record, array $field, array $values) Uniqueness method used for collection public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Validation\Validator\Url
extends abstract class Phalcon\Validation\Validator implements Phalcon\Validation\ValidatorInterface Checks if a value has a url format
use Phalcon\Validation\Validator\Url as UrlValidator;
$validator->add( "url", new UrlValidator( [ "message" =>":field must be a url", ] ) );
$validator->add( [ "url", "homepage", ], new UrlValidator( [
2.5. API 1045 Phalcon PHP Framework Documentation, Release 3.1.1
"message" =>[ "url" =>"url must be a url", "homepage" =>"homepage must be a url", ] ] ) );
Methods public validate (Phalcon\Validation $validation, mixed $field) Executes the validation public __construct ([array $options]) inherited from Phalcon\Validation\Validator Phalcon\Validation\Validator constructor public isSetOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option has been defined public hasOption (mixed $key) inherited from Phalcon\Validation\Validator Checks if an option is defined public getOption (mixed $key, [mixed $defaultValue]) inherited from Phalcon\Validation\Validator Returns an option in the validator’s options Returns null if the option hasn’t set public setOption (mixed $key, mixed $value) inherited from Phalcon\Validation\Validator Sets an option in the validator
Class Phalcon\Version
This class allows to get the installed version of the framework
Methods protected static _getVersion () Area where the version number is set. The format is as follows: ABBCCDE A - Major version B - Med version (two digits) C - Min version (two digits) D - Special release: 1 = Alpha, 2 = Beta, 3 = RC, 4 = Stable E - Special release version i.e. RC1, Beta2 etc.
final protected static _getSpecial (mixed $special) Translates a number to a special release If Special release = 1 this function will return ALPHA public static get () Returns the active version (string)
Interface Phalcon\Acl\AdapterInterface
Methods abstract public setDefaultAction (mixed $defaultAccess) ... abstract public getDefaultAction () ... abstract public setNoArgumentsDefaultAction (mixed $defaultAccess) ... abstract public getNoArgumentsDefaultAction () ... abstract public addRole (mixed $role, [mixed $accessInherits]) ... abstract public addInherit (mixed $roleName, mixed $roleToInherit) ... abstract public isRole (mixed $roleName) ... abstract public isResource (mixed $resourceName)
2.5. API 1047 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public addResource (mixed $resourceObject, mixed $accessList) ... abstract public addResourceAccess (mixed $resourceName, mixed $accessList) ... abstract public dropResourceAccess (mixed $resourceName, mixed $accessList) ... abstract public allow (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) ... abstract public deny (mixed $roleName, mixed $resourceName, mixed $access, [mixed $func]) ... abstract public isAllowed (mixed $roleName, mixed $resourceName, mixed $access, [array $parameters]) ... abstract public getActiveRole () ... abstract public getActiveResource () ... abstract public getActiveAccess () ... abstract public getRoles () ... abstract public getResources () ...
Interface Phalcon\Acl\ResourceAware
Methods abstract public getResourceName () ...
Interface Phalcon\Acl\ResourceInterface
Methods abstract public getName () ... abstract public getDescription () ...
1048 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public __toString () ...
Interface Phalcon\Acl\RoleAware
Methods abstract public getRoleName () ...
Interface Phalcon\Acl\RoleInterface
Methods abstract public getName () ... abstract public getDescription () ... abstract public __toString () ...
Interface Phalcon\Annotations\AdapterInterface
Methods abstract public setReader (Phalcon\Annotations\ReaderInterface $reader) ... abstract public getReader () ... abstract public get (mixed $className) ... abstract public getMethods (mixed $className) ... abstract public getMethod (mixed $className, mixed $methodName) ... abstract public getProperties (mixed $className) ... abstract public getProperty (mixed $className, mixed $propertyName) ...
2.5. API 1049 Phalcon PHP Framework Documentation, Release 3.1.1
Interface Phalcon\Annotations\ReaderInterface
Methods abstract public parse (mixed $className) ... abstract public static parseDocBlock (mixed $docBlock, [mixed $file], [mixed $line]) ...
Interface Phalcon\Assets\FilterInterface
Methods abstract public filter (mixed $content) ...
Interface Phalcon\Cache\BackendInterface
Methods abstract public start (mixed $keyName, [mixed $lifetime]) ... abstract public stop ([mixed $stopBuffer]) ... abstract public getFrontend () ... abstract public getOptions () ... abstract public isFresh () ... abstract public isStarted () ... abstract public setLastKey (mixed $lastKey) ... abstract public getLastKey () ... abstract public get (mixed $keyName, [mixed $lifetime]) ... abstract public save ([mixed $keyName], [mixed $content], [mixed $lifetime], [mixed $stopBuffer]) ...
1050 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public delete (mixed $keyName) ... abstract public queryKeys ([mixed $prefix]) ... abstract public exists ([mixed $keyName], [mixed $lifetime]) ...
Interface Phalcon\Cache\FrontendInterface
Methods abstract public getLifetime () ... abstract public isBuffering () ... abstract public start () ... abstract public getContent () ... abstract public stop () ... abstract public beforeStore (mixed $data) ... abstract public afterRetrieve (mixed $data) ...
Methods abstract public setTaskSuffix (mixed $taskSuffix) ... abstract public setDefaultTask (mixed $taskName) ... abstract public setTaskName (mixed $taskName) ... abstract public getTaskName ()
2.5. API 1051 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public getLastTask () ... abstract public getActiveTask () ... abstract public setActionSuffix (mixed $actionSuffix) inherited from Phalcon\DispatcherInterface ... abstract public getActionSuffix () inherited from Phalcon\DispatcherInterface ... abstract public setDefaultNamespace (mixed $defaultNamespace) inherited from Phalcon\DispatcherInterface ... abstract public setDefaultAction (mixed $actionName) inherited from Phalcon\DispatcherInterface ... abstract public setNamespaceName (mixed $namespaceName) inherited from Phalcon\DispatcherInterface ... abstract public setModuleName (mixed $moduleName) inherited from Phalcon\DispatcherInterface ... abstract public setActionName (mixed $actionName) inherited from Phalcon\DispatcherInterface ... abstract public getActionName () inherited from Phalcon\DispatcherInterface ... abstract public setParams (mixed $params) inherited from Phalcon\DispatcherInterface ... abstract public getParams () inherited from Phalcon\DispatcherInterface ... abstract public setParam (mixed $param, mixed $value) inherited from Phalcon\DispatcherInterface ... abstract public getParam (mixed $param, [mixed $filters]) inherited from Phalcon\DispatcherInterface ... abstract public hasParam (mixed $param) inherited from Phalcon\DispatcherInterface ... abstract public isFinished () inherited from Phalcon\DispatcherInterface ... abstract public getReturnedValue () inherited from Phalcon\DispatcherInterface ... abstract public dispatch () inherited from Phalcon\DispatcherInterface
Methods abstract public getSchemaName () ... abstract public getName () ... abstract public getType () ... abstract public getTypeReference () ... abstract public getTypeValues () ... abstract public getSize () ... abstract public getScale () ... abstract public isUnsigned () ... abstract public isNotNull () ... abstract public isPrimary () ... abstract public isAutoIncrement () ... abstract public isNumeric () ... abstract public isFirst () ... abstract public getAfterPosition () ... abstract public getBindType () ... abstract public getDefault () ... abstract public hasDefault ()
2.5. API 1059 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public static __set_state (array $data) ...
Interface Phalcon\Db\DialectInterface
Methods abstract public limit (mixed $sqlQuery, mixed $number) ... abstract public forUpdate (mixed $sqlQuery) ... abstract public sharedLock (mixed $sqlQuery) ... abstract public select (array $definition) ... abstract public getColumnList (array $columnList) ... abstract public getColumnDefinition (Phalcon\Db\ColumnInterface $column) ... abstract public addColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column) ... abstract public modifyColumn (mixed $tableName, mixed $schemaName, Phalcon\Db\ColumnInterface $column, [Phalcon\Db\ColumnInterface $currentColumn]) ... abstract public dropColumn (mixed $tableName, mixed $schemaName, mixed $columnName) ... abstract public addIndex (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) ... abstract public dropIndex (mixed $tableName, mixed $schemaName, mixed $indexName) ... abstract public addPrimaryKey (mixed $tableName, mixed $schemaName, Phalcon\Db\IndexInterface $index) ... abstract public dropPrimaryKey (mixed $tableName, mixed $schemaName) ... abstract public addForeignKey (mixed $tableName, mixed $schemaName, Phalcon\Db\ReferenceInterface $refer- ence) ...
1060 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public dropForeignKey (mixed $tableName, mixed $schemaName, mixed $referenceName) ... abstract public createTable (mixed $tableName, mixed $schemaName, array $definition) ... abstract public createView (mixed $viewName, array $definition, [mixed $schemaName]) ... abstract public dropTable (mixed $tableName, mixed $schemaName) ... abstract public dropView (mixed $viewName, [mixed $schemaName], [mixed $ifExists]) ... abstract public tableExists (mixed $tableName, [mixed $schemaName]) ... abstract public viewExists (mixed $viewName, [mixed $schemaName]) ... abstract public describeColumns (mixed $table, [mixed $schema]) ... abstract public listTables ([mixed $schemaName]) ... abstract public describeIndexes (mixed $table, [mixed $schema]) ... abstract public describeReferences (mixed $table, [mixed $schema]) ... abstract public tableOptions (mixed $table, [mixed $schema]) ... abstract public supportsSavepoints () ... abstract public supportsReleaseSavepoints () ... abstract public createSavepoint (mixed $name) ... abstract public releaseSavepoint (mixed $name) ... abstract public rollbackSavepoint (mixed $name) ...
2.5. API 1061 Phalcon PHP Framework Documentation, Release 3.1.1
Interface Phalcon\Db\IndexInterface
Methods abstract public getName () ... abstract public getColumns () ... abstract public getType () ... abstract public static __set_state (array $data) ...
Interface Phalcon\Db\ReferenceInterface
Methods abstract public getName () ... abstract public getSchemaName () ... abstract public getReferencedSchema () ... abstract public getColumns () ... abstract public getReferencedTable () ... abstract public getReferencedColumns () ... abstract public getOnDelete () ... abstract public getOnUpdate () ... abstract public static __set_state (array $data) ...
Methods abstract public setStatusCode (mixed $code, [mixed $message]) ... abstract public getHeaders () ... abstract public setHeader (mixed $name, mixed $value) ... abstract public setRawHeader (mixed $header) ... abstract public resetHeaders () ... abstract public setExpires (DateTime $datetime) ... abstract public setNotModified () ... abstract public setContentType (mixed $contentType, [mixed $charset]) ... abstract public setContentLength (mixed $contentLength) ... abstract public redirect ([mixed $location], [mixed $externalRedirect], [mixed $statusCode]) ... abstract public setContent (mixed $content) ... abstract public setJsonContent (mixed $content) ... abstract public appendContent (mixed $content) ... abstract public getContent () ... abstract public sendHeaders () ... abstract public sendCookies () ... abstract public send ()
2.5. API 1075 Phalcon PHP Framework Documentation, Release 3.1.1
... abstract public setFileToSend (mixed $filePath, [mixed $attachmentName]) ...
Interface Phalcon\Http\Response\CookiesInterface
Methods abstract public useEncryption (mixed $useEncryption) ... abstract public isUsingEncryption () ... abstract public set (mixed $name, [mixed $value], [mixed $expire], [mixed $path], [mixed $secure], [mixed $domain], [mixed $httpOnly]) ... abstract public get (mixed $name) ... abstract public has (mixed $name) ... abstract public delete (mixed $name) ... abstract public send () ... abstract public reset () ...
Interface Phalcon\Http\Response\HeadersInterface
Methods abstract public set (mixed $name, mixed $value) ... abstract public get (mixed $name) ... abstract public setRaw (mixed $header) ... abstract public send () ... abstract public reset ()
Methods abstract public setControllerSuffix (mixed $controllerSuffix) ... abstract public setDefaultController (mixed $controllerName) ... abstract public setControllerName (mixed $controllerName) ... abstract public getControllerName () ... abstract public getLastController () ... abstract public getActiveController () ...
2.5. API 1081 Phalcon PHP Framework Documentation, Release 3.1.1 abstract public setActionSuffix (mixed $actionSuffix) inherited from Phalcon\DispatcherInterface ... abstract public getActionSuffix () inherited from Phalcon\DispatcherInterface ... abstract public setDefaultNamespace (mixed $defaultNamespace) inherited from Phalcon\DispatcherInterface ... abstract public setDefaultAction (mixed $actionName) inherited from Phalcon\DispatcherInterface ... abstract public setNamespaceName (mixed $namespaceName) inherited from Phalcon\DispatcherInterface ... abstract public setModuleName (mixed $moduleName) inherited from Phalcon\DispatcherInterface ... abstract public setActionName (mixed $actionName) inherited from Phalcon\DispatcherInterface ... abstract public getActionName () inherited from Phalcon\DispatcherInterface ... abstract public setParams (mixed $params) inherited from Phalcon\DispatcherInterface ... abstract public getParams () inherited from Phalcon\DispatcherInterface ... abstract public setParam (mixed $param, mixed $value) inherited from Phalcon\DispatcherInterface ... abstract public getParam (mixed $param, [mixed $filters]) inherited from Phalcon\DispatcherInterface ... abstract public hasParam (mixed $param) inherited from Phalcon\DispatcherInterface ... abstract public isFinished () inherited from Phalcon\DispatcherInterface ... abstract public getReturnedValue () inherited from Phalcon\DispatcherInterface ... abstract public dispatch () inherited from Phalcon\DispatcherInterface ... abstract public forward (mixed $forward) inherited from Phalcon\DispatcherInterface ...
Methods abstract public setLayoutsDir (mixed $layoutsDir) ... abstract public getLayoutsDir () ... abstract public setPartialsDir (mixed $partialsDir) ... abstract public getPartialsDir () ...
2.5. API 1103 Phalcon PHP Framework Documentation, Release 3.1.1 abstract public setBasePath (mixed $basePath) ... abstract public getBasePath () ... abstract public setRenderLevel (mixed $level) ... abstract public setMainView (mixed $viewPath) ... abstract public getMainView () ... abstract public setLayout (mixed $layout) ... abstract public getLayout () ... abstract public setTemplateBefore (mixed $templateBefore) ... abstract public cleanTemplateBefore () ... abstract public setTemplateAfter (mixed $templateAfter) ... abstract public cleanTemplateAfter () ... abstract public getControllerName () ... abstract public getActionName () ... abstract public getParams () ... abstract public start () ... abstract public registerEngines (array $engines) ... abstract public render (mixed $controllerName, mixed $actionName, [mixed $params]) ... abstract public pick (mixed $renderView) ...
1104 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public finish () ... abstract public getActiveRenderPath () ... abstract public disable () ... abstract public enable () ... abstract public reset () ... abstract public isDisabled () ... abstract public setViewsDir (mixed $viewsDir) inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public getViewsDir () inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public setParamToView (mixed $key, mixed $value) inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public setVar (mixed $key, mixed $value) inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public getParamsToView () inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public getCache () inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public cache ([mixed $options]) inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public setContent (mixed $content) inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public getContent () inherited from Phalcon\Mvc\ViewBaseInterface ... abstract public partial (mixed $partialPath, [mixed $params]) inherited from Phalcon\Mvc\ViewBaseInterface ...
2.5. API 1105 Phalcon PHP Framework Documentation, Release 3.1.1
Interface Phalcon\Mvc\View\EngineInterface
Methods abstract public getContent () ... abstract public partial (mixed $partialPath, [mixed $params]) ... abstract public render (mixed $path, mixed $params, [mixed $mustClean]) ...
Interface Phalcon\Paginator\AdapterInterface
Methods abstract public setCurrentPage (mixed $page) ... abstract public getPaginate () ... abstract public setLimit (mixed $limit) ... abstract public getLimit () ...
Interface Phalcon\Session\AdapterInterface
Methods abstract public start () ... abstract public setOptions (array $options) ... abstract public getOptions () ... abstract public get (mixed $index, [mixed $defaultValue]) ... abstract public set (mixed $index, mixed $value) ... abstract public has (mixed $index) ...
1106 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public remove (mixed $index) ... abstract public getId () ... abstract public isStarted () ... abstract public destroy ([mixed $removeData]) ... abstract public regenerateId ([mixed $deleteOldSession]) ... abstract public setName (mixed $name) ... abstract public getName () ...
Interface Phalcon\Session\BagInterface
Methods abstract public initialize () ... abstract public destroy () ... abstract public set (mixed $property, mixed $value) ... abstract public get (mixed $property, [mixed $defaultValue]) ... abstract public has (mixed $property) ... abstract public __set (mixed $property, mixed $value) ... abstract public __get (mixed $property) ... abstract public __isset (mixed $property) ...
2.5. API 1107 Phalcon PHP Framework Documentation, Release 3.1.1
Interface Phalcon\Translate\AdapterInterface
Methods abstract public t (mixed $translateKey, [mixed $placeholders]) ... abstract public query (mixed $index, [mixed $placeholders]) ... abstract public exists (mixed $index) ...
Interface Phalcon\Translate\InterpolatorInterface
Methods abstract public replacePlaceholders (mixed $translation, [mixed $placeholders]) ...
Interface Phalcon\ValidationInterface
Methods abstract public validate ([mixed $data], [mixed $entity]) ... abstract public add (mixed $field, Phalcon\Validation\ValidatorInterface $validator) ... abstract public rule (mixed $field, Phalcon\Validation\ValidatorInterface $validator) ... abstract public rules (mixed $field, array $validators) ... abstract public setFilters (mixed $field, mixed $filters) ... abstract public getFilters ([mixed $field]) ... abstract public getValidators () ... abstract public getEntity () ... abstract public setDefaultMessages ([array $messages]) ...
1108 Chapter 2. Daftar Isi Phalcon PHP Framework Documentation, Release 3.1.1 abstract public getDefaultMessage (mixed $type) ... abstract public getMessages () ... abstract public setLabels (array $labels) ... abstract public getLabel (mixed $field) ... abstract public appendMessage (Phalcon\Validation\MessageInterface $message) ... abstract public bind (mixed $entity, mixed $data) ... abstract public getValue (mixed $field) ...
Interface Phalcon\Validation\MessageInterface
Methods abstract public setType (mixed $type) ... abstract public getType () ... abstract public setMessage (mixed $message) ... abstract public getMessage () ... abstract public setField (mixed $field) ... abstract public getField () ... abstract public __toString () ... abstract public static __set_state (array $message) ...
2.5. API 1109 Phalcon PHP Framework Documentation, Release 3.1.1
Interface Phalcon\Validation\ValidatorInterface
Methods abstract public hasOption (mixed $key) ... abstract public getOption (mixed $key, [mixed $defaultValue]) ... abstract public validate (Phalcon\Validation $validation, mixed $attribute) ...
Legal
License
Phalcon is brought to you by the Phalcon Team! [Twitter- Google Plus- Github] The Phalcon PHP Framework is released under the new BSD license. Except where otherwise noted, content on this site is licensed under the Creative Commons Attribution 3.0 License. If you love Phalcon please return something to the community! :)
